Skip to content

Commit 9f7e9c8

Browse files
docs: improve doctests for ndarray instances in ndarray/scusum
PR-URL: #10403 Ref: #9329 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 920af07 commit 9f7e9c8

File tree

5 files changed

+6
-23
lines changed

5 files changed

+6
-23
lines changed

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Computes the cumulative sum of a one-dimensional single-precision floating-point
4242

4343
```javascript
4444
var Float32Array = require( '@stdlib/array/float32' );
45-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
4645
var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
4746
var ndarray = require( '@stdlib/ndarray/base/ctor' );
4847

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

5756
var v = scusum( [ x, y, initial ] );
58-
// returns <ndarray>
57+
// returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
5958

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

6763
The function has the following parameters:

lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/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/scusum/docs/types/index.d.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ import { float32ndarray } from '@stdlib/types/ndarray';
3030
*
3131
* @example
3232
* var Float32Array = require( '@stdlib/array/float32' );
33-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3433
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
3534
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
3635
*
@@ -43,13 +42,10 @@ import { float32ndarray } from '@stdlib/types/ndarray';
4342
* var initial = scalar2ndarray( 0.0, 'float32', 'row-major' );
4443
*
4544
* var v = scusum( [ x, y, initial ] );
46-
* // returns <ndarray>
45+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
4746
*
4847
* var bool = ( v === y );
4948
* // returns true
50-
*
51-
* var arr = ndarray2array( v );
52-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
5349
*/
5450
declare function scusum( arrays: [ float32ndarray, float32ndarray, float32ndarray ] ): float32ndarray;
5551

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
*
2626
* @example
2727
* var Float32Array = require( '@stdlib/array/float32' );
28-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2928
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
3029
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
3130
* var scusum = require( '@stdlib/blas/ext/base/ndarray/scusum' );
@@ -39,13 +38,10 @@
3938
* var initial = scalar2ndarray( 0.0, 'float32', 'row-major' );
4039
*
4140
* var v = scusum( [ x, y, initial ] );
42-
* // returns <ndarray>
41+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
4342
*
4443
* var bool = ( v === y );
4544
* // returns true
46-
*
47-
* var arr = ndarray2array( v );
48-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
4945
*/
5046

5147
// MODULES //

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ var strided = require( '@stdlib/blas/ext/base/scusum' ).ndarray;
3838
*
3939
* @example
4040
* var Float32Array = require( '@stdlib/array/float32' );
41-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
4241
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
4342
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
4443
*
@@ -51,13 +50,10 @@ var strided = require( '@stdlib/blas/ext/base/scusum' ).ndarray;
5150
* var initial = scalar2ndarray( 0.0, 'float32', 'row-major' );
5251
*
5352
* var v = scusum( [ x, y, initial ] );
54-
* // returns <ndarray>
53+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
5554
*
5655
* var bool = ( v === y );
5756
* // returns true
58-
*
59-
* var arr = ndarray2array( v );
60-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
6157
*/
6258
function scusum( arrays ) {
6359
var x = arrays[ 0 ];

0 commit comments

Comments
 (0)