From 5485e33dbbdbc7048a20e0ad1584c0e2e029523a Mon Sep 17 00:00:00 2001 From: shiavm006 Date: Sat, 27 Dec 2025 02:42:42 +0530 Subject: [PATCH 1/2] docs: improve doctests for ndarray instances in `stats/maxsorted` --- .../@stdlib/stats/maxsorted/README.md | 49 ++++--------------- .../@stdlib/stats/maxsorted/docs/repl.txt | 9 ++-- .../stats/maxsorted/docs/types/index.d.ts | 20 ++------ .../@stdlib/stats/maxsorted/lib/index.js | 5 +- .../@stdlib/stats/maxsorted/lib/main.js | 5 +- 5 files changed, 19 insertions(+), 69 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/maxsorted/README.md b/lib/node_modules/@stdlib/stats/maxsorted/README.md index 77e1a96a48f4..4ab425b726ff 100644 --- a/lib/node_modules/@stdlib/stats/maxsorted/README.md +++ b/lib/node_modules/@stdlib/stats/maxsorted/README.md @@ -40,10 +40,7 @@ var array = require( '@stdlib/ndarray/array' ); var x = array( [ 1.0, 2.0, 3.0 ] ); var y = maxsorted( x ); -// returns - -var v = y.get(); -// returns 3.0 +// returns [ 3.0 ] ``` The function has the following parameters: @@ -60,81 +57,58 @@ The function accepts the following options: By default, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform a reduction over specific dimensions, provide a `dims` option. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var array = require( '@stdlib/ndarray/array' ); var x = array( [ 1.0, 2.0, 3.0, 4.0 ], { 'shape': [ 2, 2 ], 'order': 'row-major' }); -var v = ndarray2array( x ); -// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] +// returns var y = maxsorted( x, { 'dims': [ 0 ] }); -// returns - -v = ndarray2array( y ); -// returns [ 3.0, 4.0 ] +// returns [ 3.0, 4.0 ] y = maxsorted( x, { 'dims': [ 1 ] }); -// returns - -v = ndarray2array( y ); -// returns [ 2.0, 4.0 ] +// returns [ 2.0, 4.0 ] y = maxsorted( x, { 'dims': [ 0, 1 ] }); -// returns - -v = y.get(); -// returns 4.0 +// returns [ 4.0 ] ``` By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var array = require( '@stdlib/ndarray/array' ); var x = array( [ 1.0, 2.0, 3.0, 4.0 ], { 'shape': [ 2, 2 ], 'order': 'row-major' }); - -var v = ndarray2array( x ); -// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] +// returns var y = maxsorted( x, { 'dims': [ 0 ], 'keepdims': true }); -// returns - -v = ndarray2array( y ); -// returns [ [ 3.0, 4.0 ] ] +// returns [ [ 3.0, 4.0 ] ] y = maxsorted( x, { 'dims': [ 1 ], 'keepdims': true }); -// returns - -v = ndarray2array( y ); -// returns [ [ 2.0 ], [ 4.0 ] ] +// returns [ [ 2.0 ], [ 4.0 ] ] y = maxsorted( x, { 'dims': [ 0, 1 ], 'keepdims': true }); -// returns - -v = ndarray2array( y ); -// returns [ [ 4.0 ] ] +// returns [ [ 4.0 ] ] ``` By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option. @@ -168,10 +142,7 @@ var x = array( [ 1.0, 2.0, 3.0 ] ); var y = zeros( [] ); var out = maxsorted.assign( x, y ); -// returns - -var v = out.get(); -// returns 3.0 +// returns [ 3.0 ] var bool = ( out === y ); // returns true diff --git a/lib/node_modules/@stdlib/stats/maxsorted/docs/repl.txt b/lib/node_modules/@stdlib/stats/maxsorted/docs/repl.txt index 63dcb7772fef..1499b10c8a6f 100644 --- a/lib/node_modules/@stdlib/stats/maxsorted/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/maxsorted/docs/repl.txt @@ -31,9 +31,8 @@ Examples -------- > var x = {{alias:@stdlib/ndarray/array}}( [ 1.0, 2.0, 3.0, 4.0 ] ); - > var y = {{alias}}( x ); - > var v = y.get() - 4.0 + > var y = {{alias}}( x ) + [ 4.0 ] {{alias}}.assign( x, out[, options] ) @@ -66,11 +65,9 @@ > var x = {{alias:@stdlib/ndarray/array}}( [ 1.0, 2.0, 3.0, 4.0 ] ); > var out = {{alias:@stdlib/ndarray/zeros}}( [] ); > var y = {{alias}}.assign( x, out ) - + [ 4.0 ] > var bool = ( out === y ) true - > var v = out.get() - 4.0 See Also -------- diff --git a/lib/node_modules/@stdlib/stats/maxsorted/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/maxsorted/docs/types/index.d.ts index 786d4f77cbcc..32d01f958647 100644 --- a/lib/node_modules/@stdlib/stats/maxsorted/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/maxsorted/docs/types/index.d.ts @@ -75,10 +75,7 @@ interface Unary { * var x = array( [ 1.0, 2.0, 3.0 ] ); * * var y = maxsorted( x ); - * // returns - * - * var v = y.get(); - * // returns 3.0 + * // returns [ 3.0 ] */ ( x: InputArray, options?: Options ): OutputArray; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`. @@ -98,10 +95,7 @@ interface Unary { * var y = zeros( [] ); * * var out = maxsorted.assign( x, y ); - * // returns - * - * var v = out.get(); - * // returns 3.0 + * // returns [ 3.0 ] * * var bool = ( out === y ); * // returns true @@ -122,10 +116,7 @@ interface Unary { * var x = array( [ 1.0, 2.0, 3.0 ] ); * * var y = maxsorted( x ); -* // returns -* -* var v = y.get(); -* // returns 3.0 +* // returns [ 3.0 ] * * @example * var array = require( '@stdlib/ndarray/array' ); @@ -135,10 +126,7 @@ interface Unary { * var y = zeros( [] ); * * var out = maxsorted.assign( x, y ); -* // returns -* -* var v = out.get(); -* // returns 3.0 +* // returns [ 3.0 ] * * var bool = ( out === y ); * // returns true diff --git a/lib/node_modules/@stdlib/stats/maxsorted/lib/index.js b/lib/node_modules/@stdlib/stats/maxsorted/lib/index.js index 76e66057a66a..195728a7a202 100644 --- a/lib/node_modules/@stdlib/stats/maxsorted/lib/index.js +++ b/lib/node_modules/@stdlib/stats/maxsorted/lib/index.js @@ -45,10 +45,7 @@ * * // Perform reduction: * var out = maxsorted( x ); -* // returns -* -* var v = out.get(); -* // returns 11.0 +* // returns [ 11.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/stats/maxsorted/lib/main.js b/lib/node_modules/@stdlib/stats/maxsorted/lib/main.js index 7d738a9cec78..087c0ddc1c7d 100644 --- a/lib/node_modules/@stdlib/stats/maxsorted/lib/main.js +++ b/lib/node_modules/@stdlib/stats/maxsorted/lib/main.js @@ -88,10 +88,7 @@ var table = { * * // Perform reduction: * var out = maxsorted( x ); -* // returns -* -* var v = out.get(); -* // returns 11.0 +* // returns [ 11.0 ] */ var maxsorted = factory( table, [ idtypes ], odtypes, policies ); From 6df99141e79dfa4c3bfd4b9e3295dea96312d07f Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 26 Dec 2025 13:24:28 -0800 Subject: [PATCH 2/2] Apply suggestions from code review Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/maxsorted/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/maxsorted/README.md b/lib/node_modules/@stdlib/stats/maxsorted/README.md index 4ab425b726ff..d9f6b2c8ea12 100644 --- a/lib/node_modules/@stdlib/stats/maxsorted/README.md +++ b/lib/node_modules/@stdlib/stats/maxsorted/README.md @@ -63,7 +63,7 @@ var x = array( [ 1.0, 2.0, 3.0, 4.0 ], { 'shape': [ 2, 2 ], 'order': 'row-major' }); -// returns +// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] var y = maxsorted( x, { 'dims': [ 0 ] @@ -90,7 +90,7 @@ var x = array( [ 1.0, 2.0, 3.0, 4.0 ], { 'shape': [ 2, 2 ], 'order': 'row-major' }); -// returns +// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] var y = maxsorted( x, { 'dims': [ 0 ],