From 947577cea9b576bdfbb885105adbbe313cfff857 Mon Sep 17 00:00:00 2001 From: orthodox-64 Date: Wed, 10 Dec 2025 15:07:34 +0530 Subject: [PATCH 1/9] docs: update return annotations to use ndarray instance notation in stats/range-by --- .../@stdlib/stats/range-by/README.md | 36 +++++++------------ .../@stdlib/stats/range-by/docs/repl.txt | 8 ++--- .../stats/range-by/docs/types/index.d.ts | 20 +++-------- .../@stdlib/stats/range-by/lib/index.js | 7 ++-- .../@stdlib/stats/range-by/lib/main.js | 5 +-- 5 files changed, 22 insertions(+), 54 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/range-by/README.md b/lib/node_modules/@stdlib/stats/range-by/README.md index 3e058731a7ff..a4a91b95e1ba 100644 --- a/lib/node_modules/@stdlib/stats/range-by/README.md +++ b/lib/node_modules/@stdlib/stats/range-by/README.md @@ -52,10 +52,7 @@ function clbk( v ) { } var y = rangeBy( x, clbk ); -// returns - -var v = y.get(); -// returns 10.0 +// returns [ 10.0 ] ``` The function has the following parameters: @@ -89,10 +86,7 @@ var ctx = { 'count': 0 }; var y = rangeBy( x, clbk, ctx ); -// returns - -var v = y.get(); -// returns 10.0 +// returns [ 10.0 ] var count = ctx.count; // returns 3 @@ -119,7 +113,7 @@ 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 ] @@ -128,7 +122,7 @@ var y = rangeBy( x, opts, clbk ); // returns v = ndarray2array( y ); -// returns [ 200.0, 200.0 ] +// returns [ [ 200.0, 200.0 ] ] opts = { 'dims': [ 1 ] @@ -137,16 +131,13 @@ y = rangeBy( x, opts, clbk ); // returns v = ndarray2array( y ); -// returns [ 300.0, 700.0 ] +// returns [ [ 300.0, 700.0 ] ] opts = { 'dims': [ 0, 1 ] }; y = rangeBy( x, opts, clbk ); -// returns - -v = y.get(); -// returns 700.0 +// returns [ 700.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`. @@ -165,7 +156,7 @@ var x = array( [ -1.0, 2.0, -3.0, 4.0 ], { }); 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 ], @@ -175,7 +166,7 @@ var y = rangeBy( x, opts, clbk ); // returns v = ndarray2array( y ); -// returns [ [ 200.0, 200.0 ] ] +// returns [ [ [ 200.0, 200.0 ] ] ] opts = { 'dims': [ 1 ], @@ -185,7 +176,7 @@ y = rangeBy( x, opts, clbk ); // returns v = ndarray2array( y ); -// returns [ [ 300.0 ], [ 700.0 ] ] +// returns [ [ [ 300.0 ], [ 700.0 ] ] ] opts = { 'dims': [ 0, 1 ], @@ -195,7 +186,7 @@ y = rangeBy( x, opts, clbk ); // returns v = ndarray2array( y ); -// returns [ [ 700.0 ] ] +// returns [ [ [ [ 700.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. @@ -238,10 +229,7 @@ var x = array( [ -1.0, 2.0, -3.0 ] ); var y = zeros( [] ); var out = rangeBy.assign( x, y, clbk ); -// returns - -var v = out.get(); -// returns 500.0 +// returns [ 500.0 ] var bool = ( out === y ); // returns true @@ -316,7 +304,7 @@ var opts = { var y = rangeBy( x, opts, accessor ); // Resolve the output array data type: -var dt = getDType( y ); +var dt = String( getDType( y ) ); console.log( dt ); // Print the results: diff --git a/lib/node_modules/@stdlib/stats/range-by/docs/repl.txt b/lib/node_modules/@stdlib/stats/range-by/docs/repl.txt index 18bec535ef88..85a081c885f5 100644 --- a/lib/node_modules/@stdlib/stats/range-by/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/range-by/docs/repl.txt @@ -50,8 +50,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() - 14.0 + > y + [ 14.0 ] {{alias}}.assign( x, out[, options], clbk[, thisArg] ) @@ -102,11 +102,9 @@ > var out = {{alias:@stdlib/ndarray/zeros}}( [] ); > function clbk( v ) { return v * 2.0; }; > var y = {{alias}}.assign( x, out, clbk ) - + [ 14.0 ] > var bool = ( out === y ) true - > var v = out.get() - 14.0 See Also -------- diff --git a/lib/node_modules/@stdlib/stats/range-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/range-by/docs/types/index.d.ts index 1a214b2110dc..e151cb443fd0 100644 --- a/lib/node_modules/@stdlib/stats/range-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/range-by/docs/types/index.d.ts @@ -124,10 +124,7 @@ interface Unary { * var x = array( [ -1.0, 2.0, -3.0 ] ); * * var y = rangeBy( x, clbk ); - * // returns - * - * var v = y.get(); - * // returns 10.0 + * // returns [ 10.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 = rangeBy( x, {}, clbk ); - * // returns - * - * var v = y.get(); - * // returns 10.0 + * // returns [ 10.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 = rangeBy.assign( x, y, clbk ); - * // returns - * - * var v = out.get(); - * // returns 10.0 + * // returns [ 10.0 ] * * var bool = ( out === y ); * // returns true @@ -210,10 +201,7 @@ interface Unary { * } * * var out = rangeBy.assign( x, y, {}, clbk ); - * // returns - * - * var v = out.get(); - * // returns 10.0 + * // returns [ 10.0 ] * * var bool = ( out === y ); * // returns true diff --git a/lib/node_modules/@stdlib/stats/range-by/lib/index.js b/lib/node_modules/@stdlib/stats/range-by/lib/index.js index 4997afe71087..40f9fba033c1 100644 --- a/lib/node_modules/@stdlib/stats/range-by/lib/index.js +++ b/lib/node_modules/@stdlib/stats/range-by/lib/index.js @@ -50,11 +50,8 @@ * * // Perform reduction: * var out = rangeBy( x, clbk ); -* // returns -* -* var v = out.get(); -* // returns 18.0 -*/ +* // returns [ 18.0 ] + // MODULES // diff --git a/lib/node_modules/@stdlib/stats/range-by/lib/main.js b/lib/node_modules/@stdlib/stats/range-by/lib/main.js index 4c5abc69f373..99077272df5d 100644 --- a/lib/node_modules/@stdlib/stats/range-by/lib/main.js +++ b/lib/node_modules/@stdlib/stats/range-by/lib/main.js @@ -86,10 +86,7 @@ var table = { * * // Perform reduction: * var out = rangeBy( x, clbk ); -* // returns -* -* var v = out.get(); -* // returns 18.0 +* // returns [ 18.0 ] */ var rangeBy = factory( table, [ idtypes ], odtypes, policies ); From 2ebef8d0c66855584ecd080201f1f67a825fc5a2 Mon Sep 17 00:00:00 2001 From: orthodox-64 Date: Wed, 10 Dec 2025 16:38:20 +0530 Subject: [PATCH 2/9] fix: lint --- lib/node_modules/@stdlib/stats/range-by/lib/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/range-by/lib/index.js b/lib/node_modules/@stdlib/stats/range-by/lib/index.js index 40f9fba033c1..7fbf2bb6ef65 100644 --- a/lib/node_modules/@stdlib/stats/range-by/lib/index.js +++ b/lib/node_modules/@stdlib/stats/range-by/lib/index.js @@ -51,7 +51,7 @@ * // Perform reduction: * var out = rangeBy( x, clbk ); * // returns [ 18.0 ] - +*/ // MODULES // From c0803db49dcf047663bdf3ce3f150fdd86b0bcb7 Mon Sep 17 00:00:00 2001 From: orthodox-64 Date: Wed, 10 Dec 2025 16:45:26 +0530 Subject: [PATCH 3/9] fix: readme --- .../@stdlib/stats/range-by/README.md | 20 ------------------- 1 file changed, 20 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/range-by/README.md b/lib/node_modules/@stdlib/stats/range-by/README.md index a4a91b95e1ba..f3c2fcea1e0c 100644 --- a/lib/node_modules/@stdlib/stats/range-by/README.md +++ b/lib/node_modules/@stdlib/stats/range-by/README.md @@ -101,7 +101,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 ) { @@ -112,25 +111,18 @@ 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 ] ] var opts = { 'dims': [ 0 ] }; var y = rangeBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); // returns [ [ 200.0, 200.0 ] ] opts = { 'dims': [ 1 ] }; y = rangeBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); // returns [ [ 300.0, 700.0 ] ] opts = { @@ -143,7 +135,6 @@ y = rangeBy( x, opts, clbk ); 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 ) { @@ -154,8 +145,6 @@ 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 ] ] var opts = { @@ -163,9 +152,6 @@ var opts = { 'keepdims': true }; var y = rangeBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); // returns [ [ [ 200.0, 200.0 ] ] ] opts = { @@ -173,9 +159,6 @@ opts = { 'keepdims': true }; y = rangeBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); // returns [ [ [ 300.0 ], [ 700.0 ] ] ] opts = { @@ -183,9 +166,6 @@ opts = { 'keepdims': true }; y = rangeBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); // returns [ [ [ [ 700.0 ] ] ] ] ``` From 254586f6ebe2e139808306afaa40839133ef1200 Mon Sep 17 00:00:00 2001 From: orthodox-64 Date: Wed, 10 Dec 2025 16:49:56 +0530 Subject: [PATCH 4/9] fix: values --- .../@stdlib/stats/range-by/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/range-by/README.md b/lib/node_modules/@stdlib/stats/range-by/README.md index f3c2fcea1e0c..9a1054c5a30b 100644 --- a/lib/node_modules/@stdlib/stats/range-by/README.md +++ b/lib/node_modules/@stdlib/stats/range-by/README.md @@ -52,7 +52,7 @@ function clbk( v ) { } var y = rangeBy( x, clbk ); -// returns [ 10.0 ] +// returns [ 10 ] ``` The function has the following parameters: @@ -86,7 +86,7 @@ var ctx = { 'count': 0 }; var y = rangeBy( x, clbk, ctx ); -// returns [ 10.0 ] +// returns [ 10 ] var count = ctx.count; // returns 3 @@ -117,19 +117,19 @@ var opts = { 'dims': [ 0 ] }; var y = rangeBy( x, opts, clbk ); -// returns [ [ 200.0, 200.0 ] ] +// returns [ [ 200, 200 ] ] opts = { 'dims': [ 1 ] }; y = rangeBy( x, opts, clbk ); -// returns [ [ 300.0, 700.0 ] ] +// returns [ [ 300, 700 ] ] opts = { 'dims': [ 0, 1 ] }; y = rangeBy( x, opts, clbk ); -// returns [ 700.0 ] +// returns [ 700 ] ``` 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`. @@ -152,21 +152,21 @@ var opts = { 'keepdims': true }; var y = rangeBy( x, opts, clbk ); -// returns [ [ [ 200.0, 200.0 ] ] ] +// returns [ [ [ 200, 200 ] ] ] opts = { 'dims': [ 1 ], 'keepdims': true }; y = rangeBy( x, opts, clbk ); -// returns [ [ [ 300.0 ], [ 700.0 ] ] ] +// returns [ [ [ 300 ], [ 700 ] ] ] opts = { 'dims': [ 0, 1 ], 'keepdims': true }; y = rangeBy( x, opts, clbk ); -// returns [ [ [ [ 700.0 ] ] ] ] +// returns [ [ [ [ 700 ] ] ] ] ``` 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. @@ -209,7 +209,7 @@ var x = array( [ -1.0, 2.0, -3.0 ] ); var y = zeros( [] ); var out = rangeBy.assign( x, y, clbk ); -// returns [ 500.0 ] +// returns [ 500 ] var bool = ( out === y ); // returns true From c407dd52b89483c4e57d67518f94722e49ac1018 Mon Sep 17 00:00:00 2001 From: orthodox-64 Date: Wed, 10 Dec 2025 17:01:11 +0530 Subject: [PATCH 5/9] fix: README.md lint --- lib/node_modules/@stdlib/stats/range-by/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/range-by/README.md b/lib/node_modules/@stdlib/stats/range-by/README.md index 9a1054c5a30b..39c9fa3ba0b2 100644 --- a/lib/node_modules/@stdlib/stats/range-by/README.md +++ b/lib/node_modules/@stdlib/stats/range-by/README.md @@ -159,7 +159,7 @@ opts = { 'keepdims': true }; y = rangeBy( x, opts, clbk ); -// returns [ [ [ 300 ], [ 700 ] ] ] +// returns [ [ 300 ], [ 700 ] ] opts = { 'dims': [ 0, 1 ], From b6c453d5cc04e117474676b34ae35fe5d0c892a8 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 14 Dec 2025 22:57:59 -0800 Subject: [PATCH 6/9] docs: update returns annotations Signed-off-by: Athan --- .../@stdlib/stats/range-by/docs/types/index.d.ts | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/range-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/range-by/docs/types/index.d.ts index e151cb443fd0..f52c99fef7eb 100644 --- a/lib/node_modules/@stdlib/stats/range-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/range-by/docs/types/index.d.ts @@ -228,10 +228,7 @@ interface Unary { * } * * var y = rangeBy( x, clbk ); -* // returns -* -* var v = y.get(); -* // returns 10.0 +* // returns [ 10.0 ] * * @example * var array = require( '@stdlib/ndarray/array' ); @@ -245,10 +242,7 @@ interface Unary { * } * * var out = rangeBy.assign( x, y, clbk ); -* // returns -* -* var v = out.get(); -* // returns 10.0 +* // returns [ 10.0 ] * * var bool = ( out === y ); * // returns true From 56ac0058d0a1a5b19337e867960e0dfbc6cb3072 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 14 Dec 2025 22:58:58 -0800 Subject: [PATCH 7/9] docs: add missing decimals Signed-off-by: Athan --- .../@stdlib/stats/range-by/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/range-by/README.md b/lib/node_modules/@stdlib/stats/range-by/README.md index 39c9fa3ba0b2..c9f443d92818 100644 --- a/lib/node_modules/@stdlib/stats/range-by/README.md +++ b/lib/node_modules/@stdlib/stats/range-by/README.md @@ -52,7 +52,7 @@ function clbk( v ) { } var y = rangeBy( x, clbk ); -// returns [ 10 ] +// returns [ 10.0 ] ``` The function has the following parameters: @@ -86,7 +86,7 @@ var ctx = { 'count': 0 }; var y = rangeBy( x, clbk, ctx ); -// returns [ 10 ] +// returns [ 10.0 ] var count = ctx.count; // returns 3 @@ -117,19 +117,19 @@ var opts = { 'dims': [ 0 ] }; var y = rangeBy( x, opts, clbk ); -// returns [ [ 200, 200 ] ] +// returns [ [ 200.0, 200.0 ] ] opts = { 'dims': [ 1 ] }; y = rangeBy( x, opts, clbk ); -// returns [ [ 300, 700 ] ] +// returns [ [ 300.0, 700.0 ] ] opts = { 'dims': [ 0, 1 ] }; y = rangeBy( x, opts, clbk ); -// returns [ 700 ] +// returns [ 700.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`. @@ -152,21 +152,21 @@ var opts = { 'keepdims': true }; var y = rangeBy( x, opts, clbk ); -// returns [ [ [ 200, 200 ] ] ] +// returns [ [ [ 200.0, 200.0 ] ] ] opts = { 'dims': [ 1 ], 'keepdims': true }; y = rangeBy( x, opts, clbk ); -// returns [ [ 300 ], [ 700 ] ] +// returns [ [ 300.0 ], [ 700.0 ] ] opts = { 'dims': [ 0, 1 ], 'keepdims': true }; y = rangeBy( x, opts, clbk ); -// returns [ [ [ [ 700 ] ] ] ] +// returns [ [ [ [ 700.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. @@ -209,7 +209,7 @@ var x = array( [ -1.0, 2.0, -3.0 ] ); var y = zeros( [] ); var out = rangeBy.assign( x, y, clbk ); -// returns [ 500 ] +// returns [ 500.0 ] var bool = ( out === y ); // returns true From 57c249a0aa048476996d62c48f153ee563e14790 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 14 Dec 2025 23:00:02 -0800 Subject: [PATCH 8/9] docs: fix annotation Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/range-by/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/range-by/README.md b/lib/node_modules/@stdlib/stats/range-by/README.md index c9f443d92818..ea3844092ff0 100644 --- a/lib/node_modules/@stdlib/stats/range-by/README.md +++ b/lib/node_modules/@stdlib/stats/range-by/README.md @@ -152,7 +152,7 @@ var opts = { 'keepdims': true }; var y = rangeBy( x, opts, clbk ); -// returns [ [ [ 200.0, 200.0 ] ] ] +// returns [ [ 200.0, 200.0 ] ] opts = { 'dims': [ 1 ], From 1533b4e8926f4d75bb80b9aaef14948a5e7abfdb Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 14 Dec 2025 23:01:17 -0800 Subject: [PATCH 9/9] Apply suggestions from code review Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/range-by/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/range-by/README.md b/lib/node_modules/@stdlib/stats/range-by/README.md index ea3844092ff0..66ccdfacd8b2 100644 --- a/lib/node_modules/@stdlib/stats/range-by/README.md +++ b/lib/node_modules/@stdlib/stats/range-by/README.md @@ -117,13 +117,13 @@ var opts = { 'dims': [ 0 ] }; var y = rangeBy( x, opts, clbk ); -// returns [ [ 200.0, 200.0 ] ] +// returns [ 200.0, 200.0 ] opts = { 'dims': [ 1 ] }; y = rangeBy( x, opts, clbk ); -// returns [ [ 300.0, 700.0 ] ] +// returns [ 300.0, 700.0 ] opts = { 'dims': [ 0, 1 ] @@ -166,7 +166,7 @@ opts = { 'keepdims': true }; y = rangeBy( x, opts, clbk ); -// returns [ [ [ [ 700.0 ] ] ] ] +// returns [ [ 700.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.