Skip to content

Commit 638fdf0

Browse files
authored
docs: improve doctests for ndarray instances in blas/ext/base/ndarray/gcusumkbn2
PR-URL: #11576 Reviewed-by: Athan Reines <kgryte@gmail.com> Ref: #9329
1 parent 3c29f4b commit 638fdf0

File tree

5 files changed

+6
-23
lines changed

5 files changed

+6
-23
lines changed

lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusumkbn2/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ var gcusumkbn2 = require( '@stdlib/blas/ext/base/ndarray/gcusumkbn2' );
4141
Computes the cumulative sum of a one-dimensional ndarray using a second-order iterative Kahan–Babuška algorithm.
4242

4343
```javascript
44-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
4544
var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
4645
var ndarray = require( '@stdlib/ndarray/base/ctor' );
4746

@@ -54,13 +53,10 @@ var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
5453
var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
5554

5655
var v = gcusumkbn2( [ x, y, initial ] );
57-
// returns <ndarray>
56+
// returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
5857

5958
var bool = ( v === y );
6059
// returns true
61-
62-
var arr = ndarray2array( v );
63-
// returns [ 1.0, 4.0, 8.0, 10.0 ]
6460
```
6561

6662
The function has the following parameters:

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,8 @@
3030
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord );
3131
> var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord );
3232
> var s = {{alias:@stdlib/ndarray/from-scalar}}( 0.0, { 'dtype': dt } );
33-
> {{alias}}( [ x, y, s ] );
34-
> {{alias:@stdlib/ndarray/to-array}}( y )
35-
[ 1.0, -1.0, 1.0 ]
33+
> {{alias}}( [ x, y, s ] )
34+
<ndarray>[ 1.0, -1.0, 1.0 ]
3635

3736
See Also
3837
--------

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ import { typedndarray } from '@stdlib/types/ndarray';
2929
* @returns output ndarray
3030
*
3131
* @example
32-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3332
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
3433
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
3534
*
@@ -42,13 +41,10 @@ import { typedndarray } from '@stdlib/types/ndarray';
4241
* var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
4342
*
4443
* var v = gcusumkbn2( [ x, y, initial ] );
45-
* // returns <ndarray>
44+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
4645
*
4746
* var bool = ( v === y );
4847
* // returns true
49-
*
50-
* var arr = ndarray2array( v );
51-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
5248
*/
5349
declare function gcusumkbn2<T extends typedndarray<number> = typedndarray<number>>( arrays: [ T, T, T ] ): T;
5450

lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusumkbn2/lib/index.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
* @module @stdlib/blas/ext/base/ndarray/gcusumkbn2
2525
*
2626
* @example
27-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2827
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
2928
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
3029
* var gcusumkbn2 = require( '@stdlib/blas/ext/base/ndarray/gcusumkbn2' );
@@ -38,13 +37,10 @@
3837
* var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
3938
*
4039
* var v = gcusumkbn2( [ x, y, initial ] );
41-
* // returns <ndarray>
40+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
4241
*
4342
* var bool = ( v === y );
4443
* // returns true
45-
*
46-
* var arr = ndarray2array( v );
47-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
4844
*/
4945

5046
// MODULES //

lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusumkbn2/lib/main.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ var strided = require( '@stdlib/blas/ext/base/gcusumkbn2' ).ndarray;
3737
* @returns {Object} output ndarray
3838
*
3939
* @example
40-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
4140
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
4241
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
4342
*
@@ -50,13 +49,10 @@ var strided = require( '@stdlib/blas/ext/base/gcusumkbn2' ).ndarray;
5049
* var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
5150
*
5251
* var v = gcusumkbn2( [ x, y, initial ] );
53-
* // returns <ndarray>
52+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
5453
*
5554
* var bool = ( v === y );
5655
* // returns true
57-
*
58-
* var arr = ndarray2array( v );
59-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
6056
*/
6157
function gcusumkbn2( arrays ) {
6258
var x = arrays[ 0 ];

0 commit comments

Comments
 (0)