From 406d1c99fb769ad14fb117e2e7ffe5afbef03165 Mon Sep 17 00:00:00 2001 From: Ayushi Jain Date: Fri, 13 Feb 2026 11:51:05 +0000 Subject: [PATCH] docs: improve doctests for ndarray instances in --- .../@stdlib/blas/ext/base/ndarray/gcusum/README.md | 6 +----- .../@stdlib/blas/ext/base/ndarray/gcusum/docs/repl.txt | 5 ++--- .../blas/ext/base/ndarray/gcusum/docs/types/index.d.ts | 6 +----- .../@stdlib/blas/ext/base/ndarray/gcusum/lib/index.js | 6 +----- .../@stdlib/blas/ext/base/ndarray/gcusum/lib/main.js | 6 +----- 5 files changed, 6 insertions(+), 23 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/README.md index a44165d0ec6f..2b6d3b5de386 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/README.md @@ -41,7 +41,6 @@ var gcusum = require( '@stdlib/blas/ext/base/ndarray/gcusum' ); Computes the cumulative sum of a one-dimensional ndarray. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); @@ -54,13 +53,10 @@ var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); var initial = scalar2ndarray( 0.0, 'generic', 'row-major' ); var v = gcusum( [ 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/gcusum/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/docs/repl.txt index 5c39fa782a71..3bf481fecb77 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/docs/repl.txt @@ -29,9 +29,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/gcusum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/docs/types/index.d.ts index c17528aa9706..6a6a805f935a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/docs/types/index.d.ts @@ -29,7 +29,6 @@ import { typedndarray } from '@stdlib/types/ndarray'; * @returns output ndarray * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * @@ -42,13 +41,10 @@ import { typedndarray } from '@stdlib/types/ndarray'; * var initial = scalar2ndarray( 0.0, 'generic', 'row-major' ); * * var v = gcusum( [ 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 gcusum = typedndarray>( arrays: [ T, T, T ] ): T; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/lib/index.js index 6a10e64d1129..505df521362c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/lib/index.js @@ -24,7 +24,6 @@ * @module @stdlib/blas/ext/base/ndarray/gcusum * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); * var gcusum = require( '@stdlib/blas/ext/base/ndarray/gcusum' ); @@ -38,13 +37,10 @@ * var initial = scalar2ndarray( 0.0, 'generic', 'row-major' ); * * var v = gcusum( [ 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/gcusum/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/lib/main.js index 356f8feea92e..4efb6fb60646 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/lib/main.js @@ -37,7 +37,6 @@ var strided = require( '@stdlib/blas/ext/base/gcusum' ).ndarray; * @returns {Object} output ndarray * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); * @@ -50,13 +49,10 @@ var strided = require( '@stdlib/blas/ext/base/gcusum' ).ndarray; * var initial = scalar2ndarray( 0.0, 'generic', 'row-major' ); * * var v = gcusum( [ 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 gcusum( arrays ) { var x = arrays[ 0 ];