From 4799ebc29e9a842368b59f1fb4b9daedf9b4be1a Mon Sep 17 00:00:00 2001 From: Ayushi Jain Date: Sat, 21 Feb 2026 14:09:57 +0000 Subject: [PATCH] docs: improve doctests for ndarray instances in --- .../@stdlib/blas/ext/base/ndarray/scusum/README.md | 6 +----- .../@stdlib/blas/ext/base/ndarray/scusum/docs/repl.txt | 5 ++--- .../blas/ext/base/ndarray/scusum/docs/types/index.d.ts | 6 +----- .../@stdlib/blas/ext/base/ndarray/scusum/lib/index.js | 6 +----- .../@stdlib/blas/ext/base/ndarray/scusum/lib/main.js | 6 +----- 5 files changed, 6 insertions(+), 23 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/README.md index f05e4be1eed7..7bb56607e592 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/README.md @@ -42,7 +42,6 @@ Computes the cumulative sum of a one-dimensional single-precision floating-point ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); @@ -55,13 +54,10 @@ var y = new ndarray( 'float32', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); var initial = scalar2ndarray( 0.0, 'float32', 'row-major' ); var v = scusum( [ x, y, initial ] ); -// returns +// returns [ 1.0, 4.0, 8.0, 10.0 ] var bool = ( v === y ); // returns true - -var arr = ndarray2array( v ); -// returns [ 1.0, 4.0, 8.0, 10.0 ] ``` The function has the following parameters: diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/docs/repl.txt index bfbef8eaa3e0..c8e27e53cbe8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/docs/repl.txt @@ -30,9 +30,8 @@ > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord ); > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord ); > var s = {{alias:@stdlib/ndarray/from-scalar}}( 0.0, { 'dtype': dt } ); - > {{alias}}( [ x, y, s ] ); - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ 1.0, -1.0, 1.0 ] + > {{alias}}( [ x, y, s ] ) + [ 1.0, -1.0, 1.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/docs/types/index.d.ts index 59ecfcfea524..dc6498522b16 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/docs/types/index.d.ts @@ -30,7 +30,6 @@ import { float32ndarray } from '@stdlib/types/ndarray'; * * @example * var Float32Array = require( '@stdlib/array/float32' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * @@ -43,13 +42,10 @@ import { float32ndarray } from '@stdlib/types/ndarray'; * var initial = scalar2ndarray( 0.0, 'float32', 'row-major' ); * * var v = scusum( [ x, y, initial ] ); -* // returns +* // returns [ 1.0, 4.0, 8.0, 10.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 4.0, 8.0, 10.0 ] */ declare function scusum( arrays: [ float32ndarray, float32ndarray, float32ndarray ] ): float32ndarray; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/lib/index.js index fe290bb9267d..42fd565c2d6d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/lib/index.js @@ -25,7 +25,6 @@ * * @example * var Float32Array = require( '@stdlib/array/float32' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); * var scusum = require( '@stdlib/blas/ext/base/ndarray/scusum' ); @@ -39,13 +38,10 @@ * var initial = scalar2ndarray( 0.0, 'float32', 'row-major' ); * * var v = scusum( [ x, y, initial ] ); -* // returns +* // returns [ 1.0, 4.0, 8.0, 10.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 4.0, 8.0, 10.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/lib/main.js index 91a86f4e578c..0dd8091a08e4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/lib/main.js @@ -38,7 +38,6 @@ var strided = require( '@stdlib/blas/ext/base/scusum' ).ndarray; * * @example * var Float32Array = require( '@stdlib/array/float32' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); * @@ -51,13 +50,10 @@ var strided = require( '@stdlib/blas/ext/base/scusum' ).ndarray; * var initial = scalar2ndarray( 0.0, 'float32', 'row-major' ); * * var v = scusum( [ x, y, initial ] ); -* // returns +* // returns [ 1.0, 4.0, 8.0, 10.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 4.0, 8.0, 10.0 ] */ function scusum( arrays ) { var x = arrays[ 0 ];