diff --git a/lib/node_modules/@stdlib/stats/range-by/README.md b/lib/node_modules/@stdlib/stats/range-by/README.md index 3e058731a7ff..66ccdfacd8b2 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 @@ -107,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 ) { @@ -118,41 +111,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 = rangeBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); -// returns [ 200.0, 200.0 ] +// returns [ 200.0, 200.0 ] opts = { 'dims': [ 1 ] }; 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`. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var array = require( '@stdlib/ndarray/array' ); function clbk( v ) { @@ -163,39 +145,28 @@ 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 ], 'keepdims': true }; var y = rangeBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); -// returns [ [ 200.0, 200.0 ] ] +// returns [ [ 200.0, 200.0 ] ] opts = { 'dims': [ 1 ], 'keepdims': true }; y = rangeBy( x, opts, clbk ); -// returns - -v = ndarray2array( y ); -// returns [ [ 300.0 ], [ 700.0 ] ] +// returns [ [ 300.0 ], [ 700.0 ] ] opts = { 'dims': [ 0, 1 ], 'keepdims': true }; 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 +209,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 +284,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..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 @@ -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 @@ -240,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' ); @@ -257,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 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..7fbf2bb6ef65 100644 --- a/lib/node_modules/@stdlib/stats/range-by/lib/index.js +++ b/lib/node_modules/@stdlib/stats/range-by/lib/index.js @@ -50,10 +50,7 @@ * * // 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 );