Skip to content

Commit c4d0293

Browse files
committed
docs: update parameter description
1 parent 3cdc9a7 commit c4d0293

6 files changed

Lines changed: 22 additions & 22 deletions

File tree

lib/node_modules/@stdlib/blas/ext/base/gvander/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The function has the following parameters:
5757
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
5858
- **strideX**: stride length for `x`.
5959
- **out**: output matrix.
60-
- **ldo**: stride of the first dimension of `out` (a.k.a., leading dimension of the matrix `out`).
60+
- **ldo**: stride between successive contiguous vectors of the matrix `out` (a.k.a., leading dimension of the matrix `out`).
6161

6262
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
6363

lib/node_modules/@stdlib/blas/ext/base/gvander/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@
4949
Output matrix.
5050

5151
ldo: integer
52-
Stride of the first dimension of `out` (a.k.a., leading dimension of
53-
the matrix `out`).
52+
Stride between successive contiguous vectors of the matrix `out`
53+
(a.k.a., leading dimension of the matrix `out`).
5454

5555
Returns
5656
-------

lib/node_modules/@stdlib/blas/ext/base/gvander/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ interface Routine {
4747
* @param x - input array
4848
* @param strideX - stride length for `x`
4949
* @param out - output matrix
50-
* @param ldo - stride of the first dimension of `out` (a.k.a., leading dimension of the matrix `out`)
50+
* @param ldo - stride between successive contiguous vectors of the matrix `out` (a.k.a., leading dimension of the matrix `out`)
5151
* @returns output matrix
5252
*
5353
* @example
@@ -94,7 +94,7 @@ interface Routine {
9494
* @param x - input array
9595
* @param strideX - stride length for `x`
9696
* @param out - output matrix
97-
* @param ldo - stride of the first dimension of `out` (a.k.a., leading dimension of the matrix `out`)
97+
* @param ldo - stride between successive contiguous vectors of the matrix `out` (a.k.a., leading dimension of the matrix `out`)
9898
* @returns output matrix
9999
*
100100
* @example

lib/node_modules/@stdlib/blas/ext/base/gvander/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ var base = require( './base.js' );
4040
* @param {NumericArray} x - input array
4141
* @param {integer} strideX - stride length for `x`
4242
* @param {NumericArray} out - output matrix
43-
* @param {PositiveInteger} ldo - stride of the first dimension of `out` (a.k.a., leading dimension of the matrix `out`)
43+
* @param {PositiveInteger} ldo - stride between successive contiguous vectors of the matrix `out` (a.k.a., leading dimension of the matrix `out`)
4444
* @throws {TypeError} first argument must be a valid order
4545
* @throws {RangeError} third argument must be a nonnegative integer
4646
* @throws {RangeError} fourth argument must be a nonnegative integer

lib/node_modules/@stdlib/blas/ext/base/gvander/test/test.main.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ tape( 'the function returns the output matrix (accessors)', function test( t ) {
377377
t.end();
378378
});
379379

380-
tape( 'the function supports specifying a stride (row-major)', function test( t ) {
380+
tape( 'the function supports specifying a stride for `x` (row-major)', function test( t ) {
381381
var expected;
382382
var out;
383383
var x;
@@ -394,7 +394,7 @@ tape( 'the function supports specifying a stride (row-major)', function test( t
394394
t.end();
395395
});
396396

397-
tape( 'the function supports specifying a stride (row-major, accessors)', function test( t ) {
397+
tape( 'the function supports specifying a stride for `x` (row-major, accessors)', function test( t ) {
398398
var expected;
399399
var out;
400400
var x;
@@ -410,7 +410,7 @@ tape( 'the function supports specifying a stride (row-major, accessors)', functi
410410
t.end();
411411
});
412412

413-
tape( 'the function supports specifying a negative stride (row-major)', function test( t ) {
413+
tape( 'the function supports specifying a negative stride for `x` (row-major)', function test( t ) {
414414
var expected;
415415
var out;
416416
var x;
@@ -428,7 +428,7 @@ tape( 'the function supports specifying a negative stride (row-major)', function
428428
t.end();
429429
});
430430

431-
tape( 'the function supports specifying a stride (column-major)', function test( t ) {
431+
tape( 'the function supports specifying a stride for `x` (column-major)', function test( t ) {
432432
var expected;
433433
var out;
434434
var x;
@@ -445,7 +445,7 @@ tape( 'the function supports specifying a stride (column-major)', function test(
445445
t.end();
446446
});
447447

448-
tape( 'the function supports specifying a stride (column-major, accessors)', function test( t ) {
448+
tape( 'the function supports specifying a stride for `x` (column-major, accessors)', function test( t ) {
449449
var expected;
450450
var out;
451451
var x;
@@ -461,7 +461,7 @@ tape( 'the function supports specifying a stride (column-major, accessors)', fun
461461
t.end();
462462
});
463463

464-
tape( 'the function supports specifying a negative stride (column-major)', function test( t ) {
464+
tape( 'the function supports specifying a negative stride for `x` (column-major)', function test( t ) {
465465
var expected;
466466
var out;
467467
var x;
@@ -675,7 +675,7 @@ tape( 'the function handles zero values in the input array (row-major, increasin
675675
t.end();
676676
});
677677

678-
tape( 'the function handles single column (N=1)', function test( t ) {
678+
tape( 'the function handles a single column (N=1)', function test( t ) {
679679
var expected;
680680
var out;
681681
var x;
@@ -692,7 +692,7 @@ tape( 'the function handles single column (N=1)', function test( t ) {
692692
t.end();
693693
});
694694

695-
tape( 'the function handles single row (M=1)', function test( t ) {
695+
tape( 'the function handles a single row (M=1)', function test( t ) {
696696
var expected;
697697
var out;
698698
var x;

lib/node_modules/@stdlib/blas/ext/base/gvander/test/test.ndarray.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ tape( 'if provided an `N` equal to `0`, the function returns the output matrix u
308308
t.end();
309309
});
310310

311-
tape( 'the function supports specifying a stride (row-major)', function test( t ) {
311+
tape( 'the function supports specifying a stride for `x` (row-major)', function test( t ) {
312312
var expected;
313313
var out;
314314
var x;
@@ -325,7 +325,7 @@ tape( 'the function supports specifying a stride (row-major)', function test( t
325325
t.end();
326326
});
327327

328-
tape( 'the function supports specifying a stride (row-major, accessors)', function test( t ) {
328+
tape( 'the function supports specifying a stride for `x` (row-major, accessors)', function test( t ) {
329329
var expected;
330330
var out;
331331
var x;
@@ -341,7 +341,7 @@ tape( 'the function supports specifying a stride (row-major, accessors)', functi
341341
t.end();
342342
});
343343

344-
tape( 'the function supports specifying a negative stride (row-major)', function test( t ) {
344+
tape( 'the function supports specifying a negative stride for `x` (row-major)', function test( t ) {
345345
var expected;
346346
var out;
347347
var x;
@@ -359,7 +359,7 @@ tape( 'the function supports specifying a negative stride (row-major)', function
359359
t.end();
360360
});
361361

362-
tape( 'the function supports specifying a stride (column-major)', function test( t ) {
362+
tape( 'the function supports specifying a stride for `x` (column-major)', function test( t ) {
363363
var expected;
364364
var out;
365365
var x;
@@ -376,7 +376,7 @@ tape( 'the function supports specifying a stride (column-major)', function test(
376376
t.end();
377377
});
378378

379-
tape( 'the function supports specifying a stride (column-major, accessors)', function test( t ) {
379+
tape( 'the function supports specifying a stride for `x` (column-major, accessors)', function test( t ) {
380380
var expected;
381381
var out;
382382
var x;
@@ -392,7 +392,7 @@ tape( 'the function supports specifying a stride (column-major, accessors)', fun
392392
t.end();
393393
});
394394

395-
tape( 'the function supports specifying a negative stride (column-major)', function test( t ) {
395+
tape( 'the function supports specifying a negative stride for `x` (column-major)', function test( t ) {
396396
var expected;
397397
var out;
398398
var x;
@@ -669,7 +669,7 @@ tape( 'the function handles zero values in the input array (row-major, increasin
669669
t.end();
670670
});
671671

672-
tape( 'the function handles single column (N=1)', function test( t ) {
672+
tape( 'the function handles a single column (N=1)', function test( t ) {
673673
var expected;
674674
var out;
675675
var x;
@@ -686,7 +686,7 @@ tape( 'the function handles single column (N=1)', function test( t ) {
686686
t.end();
687687
});
688688

689-
tape( 'the function handles single row (M=1)', function test( t ) {
689+
tape( 'the function handles a single row (M=1)', function test( t ) {
690690
var expected;
691691
var out;
692692
var x;

0 commit comments

Comments
 (0)