From 26eb73064835307059528b26d5c1869d86c822ff Mon Sep 17 00:00:00 2001 From: iampratik13 Date: Wed, 10 Dec 2025 14:55:40 +0530 Subject: [PATCH 1/2] docs: updated --- .../@stdlib/stats/max-by/README.md | 50 ++++--------------- .../@stdlib/stats/max-by/docs/repl.txt | 9 ++-- .../stats/max-by/docs/types/index.d.ts | 30 +++-------- .../@stdlib/stats/max-by/lib/index.js | 5 +- .../@stdlib/stats/max-by/lib/main.js | 5 +- 5 files changed, 22 insertions(+), 77 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/max-by/README.md b/lib/node_modules/@stdlib/stats/max-by/README.md index 05176639bc30..de9d9d4518b4 100644 --- a/lib/node_modules/@stdlib/stats/max-by/README.md +++ b/lib/node_modules/@stdlib/stats/max-by/README.md @@ -44,10 +44,7 @@ function clbk( v ) { } var y = maxBy( x, clbk ); -// returns - -var v = y.get(); -// returns 4.0 +// returns [ 4.0 ] ``` The function has the following parameters: @@ -99,7 +96,6 @@ 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' ); function clbk( v ) { @@ -110,41 +106,30 @@ 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 [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] var opts = { 'dims': [ 0 ] }; var y = maxBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); -// returns [ -100.0, 400.0 ] +// returns [ -100.0, 400.0 ] opts = { 'dims': [ 1 ] }; y = maxBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); -// returns [ 200.0, 400.0 ] +// returns [ 200.0, 400.0 ] opts = { 'dims': [ 0, 1 ] }; y = maxBy( x, opts, clbk ); -// returns - -v = y.get(); -// returns 400.0 +// returns [ 400.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' ); function clbk( v ) { @@ -156,38 +141,28 @@ var x = array( [ -1.0, 2.0, -3.0, 4.0 ], { 'order': 'row-major' }); -var v = ndarray2array( x ); -// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] +// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] var opts = { 'dims': [ 0 ], 'keepdims': true }; var y = maxBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); -// returns [ [ -100.0, 400.0 ] ] +// returns [ [ -100.0, 400.0 ] ] opts = { 'dims': [ 1 ], 'keepdims': true }; y = maxBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); -// returns [ [ 200.0 ], [ 400.0 ] ] +// returns [ [ 200.0 ], [ 400.0 ] ] opts = { 'dims': [ 0, 1 ], 'keepdims': true }; y = maxBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); -// returns [ [ 400.0 ] ] +// returns [ [ 400.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. @@ -208,7 +183,7 @@ var opts = { 'dtype': 'float64' }; var y = maxBy( x, opts, clbk ); -// returns +// returns [ 2.0 ] var dt = String( getDType( y ) ); // returns 'float64' @@ -230,10 +205,7 @@ var x = array( [ -1.0, 2.0, -3.0 ] ); var y = zeros( [] ); var out = maxBy.assign( x, y, clbk ); -// returns - -var v = out.get(); -// returns 200.0 +// returns 200.0 var bool = ( out === y ); // returns true diff --git a/lib/node_modules/@stdlib/stats/max-by/docs/repl.txt b/lib/node_modules/@stdlib/stats/max-by/docs/repl.txt index 075488b2dbe9..5829b9b10173 100644 --- a/lib/node_modules/@stdlib/stats/max-by/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/max-by/docs/repl.txt @@ -49,9 +49,8 @@ -------- > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] ); > function clbk( v ) { return v * 2.0; }; - > var y = {{alias}}( x, clbk ); - > var v = y.get() - 4.0 + > var y = {{alias}}( x, clbk ) + [ 4.0 ] {{alias}}.assign( x, out[, options], clbk[, thisArg] ) @@ -102,11 +101,9 @@ > var out = {{alias:@stdlib/ndarray/zeros}}( [] ); > function clbk( v ) { return v * 2.0; }; > var y = {{alias}}.assign( x, out, clbk ) - + [ 4.0 ] > var bool = ( out === y ) true - > var v = out.get() - 4.0 See Also -------- diff --git a/lib/node_modules/@stdlib/stats/max-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/max-by/docs/types/index.d.ts index aeceee438ea9..093745068a03 100644 --- a/lib/node_modules/@stdlib/stats/max-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/max-by/docs/types/index.d.ts @@ -124,10 +124,7 @@ interface Unary { * var x = array( [ -1.0, 2.0, -3.0 ] ); * * var y = maxBy( x, clbk ); - * // returns - * - * var v = y.get(); - * // returns 4.0 + * // returns [ 4.0 ] */ = InputArray, ThisArg = unknown>( x: U, clbk: Callback, thisArg?: ThisParameterType> ): 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`. @@ -150,10 +147,7 @@ interface Unary { * var x = array( [ -1.0, 2.0, -3.0 ] ); * * var y = maxBy( x, {}, clbk ); - * // returns - * - * var v = y.get(); - * // returns 4.0 + * // returns [ 4.0 ] */ = InputArray, ThisArg = unknown>( x: U, options: Options, clbk: Callback, thisArg?: ThisParameterType> ): 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`. @@ -178,10 +172,7 @@ interface Unary { * } * * var out = maxBy.assign( x, y, clbk ); - * // returns - * - * var v = out.get(); - * // returns 4.0 + * // returns [ 4.0 ] * * var bool = ( out === y ); * // returns true @@ -210,10 +201,7 @@ interface Unary { * } * * var out = maxBy.assign( x, y, {}, clbk ); - * // returns - * - * var v = out.get(); - * // returns 4.0 + * // returns [ 4.0 ] * * var bool = ( out === y ); * // returns true @@ -240,10 +228,7 @@ interface Unary { * } * * var y = maxBy( x, clbk ); -* // returns -* -* var v = y.get(); -* // returns 4.0 +* // returns [ 4.0 ] * * @example * var array = require( '@stdlib/ndarray/array' ); @@ -257,10 +242,7 @@ interface Unary { * } * * var out = maxBy.assign( x, y, clbk ); -* // returns -* -* var v = out.get(); -* // returns 4.0 +* // returns [ 4.0 ] * * var bool = ( out === y ); * // returns true diff --git a/lib/node_modules/@stdlib/stats/max-by/lib/index.js b/lib/node_modules/@stdlib/stats/max-by/lib/index.js index d8c1efb5e3ea..061721ae6285 100644 --- a/lib/node_modules/@stdlib/stats/max-by/lib/index.js +++ b/lib/node_modules/@stdlib/stats/max-by/lib/index.js @@ -50,10 +50,7 @@ * * // Perform reduction: * var out = maxBy( x, clbk ); -* // returns -* -* var v = out.get(); -* // returns 22.0 +* // returns [ 22.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/stats/max-by/lib/main.js b/lib/node_modules/@stdlib/stats/max-by/lib/main.js index 683558f530d0..5cbd9a8ff913 100644 --- a/lib/node_modules/@stdlib/stats/max-by/lib/main.js +++ b/lib/node_modules/@stdlib/stats/max-by/lib/main.js @@ -86,10 +86,7 @@ var table = { * * // Perform reduction: * var out = maxBy( x, clbk ); -* // returns -* -* var v = out.get(); -* // returns 22.0 +* // returns [ 22.0 ] */ var maxBy = factory( table, [ idtypes ], odtypes, policies ); From b031b34e66247ce7383694c80c31d44501a4f2a9 Mon Sep 17 00:00:00 2001 From: iampratik13 Date: Wed, 10 Dec 2025 16:49:58 +0530 Subject: [PATCH 2/2] fix: lint --- lib/node_modules/@stdlib/stats/max-by/README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/max-by/README.md b/lib/node_modules/@stdlib/stats/max-by/README.md index de9d9d4518b4..1877cd14a04e 100644 --- a/lib/node_modules/@stdlib/stats/max-by/README.md +++ b/lib/node_modules/@stdlib/stats/max-by/README.md @@ -106,7 +106,7 @@ var x = array( [ -1.0, 2.0, -3.0, 4.0 ], { 'shape': [ 2, 2 ], 'order': 'row-major' }); -// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] +// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] var opts = { 'dims': [ 0 ] @@ -141,8 +141,6 @@ var x = array( [ -1.0, 2.0, -3.0, 4.0 ], { 'order': 'row-major' }); -// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] - var opts = { 'dims': [ 0 ], 'keepdims': true @@ -183,7 +181,7 @@ var opts = { 'dtype': 'float64' }; var y = maxBy( x, opts, clbk ); -// returns [ 2.0 ] +// returns [ 200.0 ] var dt = String( getDType( y ) ); // returns 'float64' @@ -205,7 +203,7 @@ var x = array( [ -1.0, 2.0, -3.0 ] ); var y = zeros( [] ); var out = maxBy.assign( x, y, clbk ); -// returns 200.0 +// returns [ 200.0 ] var bool = ( out === y ); // returns true