From 8499b5a69bd3db58766f0b20c45da8190c26717f Mon Sep 17 00:00:00 2001 From: Uday Kakade Date: Sat, 18 Apr 2026 10:53:32 +0530 Subject: [PATCH] docs: improve doctest for ndarray instances in stats/base/ndarray/dcumax --- .../@stdlib/stats/base/ndarray/dcumax/README.md | 6 +----- .../@stdlib/stats/base/ndarray/dcumax/docs/repl.txt | 5 ++--- .../@stdlib/stats/base/ndarray/dcumax/docs/types/index.d.ts | 6 +----- .../@stdlib/stats/base/ndarray/dcumax/lib/index.js | 6 +----- .../@stdlib/stats/base/ndarray/dcumax/lib/main.js | 6 +----- 5 files changed, 6 insertions(+), 23 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/README.md index 87e061b90d93..f41201913884 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/README.md @@ -42,7 +42,6 @@ Computes the cumulative maximum value of a one-dimensional double-precision floa ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] ); @@ -52,13 +51,10 @@ var ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); var y = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); var v = dcumax( [ x, y ] ); -// returns +// returns [ 1.0, 3.0, 4.0, 4.0 ] var bool = ( v === y ); // returns true - -var arr = ndarray2array( v ); -// returns [ 1.0, 3.0, 4.0, 4.0 ] ``` The function has the following parameters: diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/docs/repl.txt index c5def9f71da3..b9499bb087f0 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/docs/repl.txt @@ -28,9 +28,8 @@ > var ord = 'row-major'; > 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 ); - > {{alias}}( [ x, y ] ); - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ 1.0, 1.0, 2.0 ] + > {{alias}}( [ x, y ] ) + [ 1.0, 1.0, 2.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/docs/types/index.d.ts index abeeb4c24e8a..6df98f0ced73 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/docs/types/index.d.ts @@ -30,7 +30,6 @@ import { float64ndarray } from '@stdlib/types/ndarray'; * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * * var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] ); @@ -40,13 +39,10 @@ import { float64ndarray } from '@stdlib/types/ndarray'; * var y = new ndarray( 'float64', ybuf, [ 4 ], [ 1 ], 0, 'row-major' ); * * var v = dcumax( [ x, y ] ); -* // returns +* // returns [ 1.0, 3.0, 4.0, 4.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 3.0, 4.0, 4.0 ] */ declare function dcumax( arrays: [ float64ndarray, float64ndarray ] ): float64ndarray; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/lib/index.js index 11e7deec9a08..9032ca7a0d62 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/lib/index.js @@ -25,7 +25,6 @@ * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * var dcumax = require( '@stdlib/stats/base/ndarray/dcumax' ); * @@ -36,13 +35,10 @@ * var y = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * * var v = dcumax( [ x, y ] ); -* // returns +* // returns [ 1.0, 3.0, 4.0, 4.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 3.0, 4.0, 4.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/lib/main.js index d42a2c0bfcbf..0d2780d0181b 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dcumax/lib/main.js @@ -37,7 +37,6 @@ var strided = require( '@stdlib/stats/strided/dcumax' ).ndarray; * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * * var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] ); @@ -47,13 +46,10 @@ var strided = require( '@stdlib/stats/strided/dcumax' ).ndarray; * var y = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * * var v = dcumax( [ x, y ] ); -* // returns +* // returns [ 1.0, 3.0, 4.0, 4.0 ] * * var bool = ( v === y ); * // returns true -* -* var arr = ndarray2array( v ); -* // returns [ 1.0, 3.0, 4.0, 4.0 ] */ function dcumax( arrays ) { var x = arrays[ 0 ];