diff --git a/lib/node_modules/@stdlib/stats/cumin/README.md b/lib/node_modules/@stdlib/stats/cumin/README.md index a74c21673d32..dec13de3523c 100644 --- a/lib/node_modules/@stdlib/stats/cumin/README.md +++ b/lib/node_modules/@stdlib/stats/cumin/README.md @@ -35,16 +35,12 @@ var cumin = require( '@stdlib/stats/cumin' ); Computes the cumulative minimum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var array = require( '@stdlib/ndarray/array' ); var x = array( [ -1.0, 2.0, -3.0 ] ); var y = cumin( x ); -// returns - -var arr = ndarray2array( y ); -// returns [ -1.0, -1.0, -3.0 ] +// returns [ -1.0, -1.0, -3.0 ] ``` The function has the following parameters: @@ -60,7 +56,6 @@ The function accepts the following options: By default, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform the operation 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 ], { @@ -68,32 +63,20 @@ 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 ] ] - var y = cumin( x, { 'dims': [ 0 ] }); -// returns - -v = ndarray2array( y ); -// returns [ [ -1.0, 2.0 ], [ -3.0, 2.0 ] ] +// returns [ [ -1.0, 2.0 ], [ -3.0, 2.0 ] ] y = cumin( x, { 'dims': [ 1 ] }); -// returns - -v = ndarray2array( y ); -// returns [ [ -1.0, -1.0 ], [ -3.0, -3.0 ] ] +// returns [ [ -1.0, -1.0 ], [ -3.0, -3.0 ] ] y = cumin( x, { 'dims': [ 0, 1 ] }); -// returns - -v = ndarray2array( y ); -// returns [ [ -1.0, -1.0 ], [ -3.0, -3.0 ] ] +// returns [ [ -1.0, -1.0 ], [ -3.0, -3.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. @@ -120,7 +103,6 @@ var dt = String( getDType( y ) ); Computes the cumulative minimum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor]. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var array = require( '@stdlib/ndarray/array' ); var zerosLike = require( '@stdlib/ndarray/zeros-like' ); @@ -128,10 +110,7 @@ var x = array( [ -1.0, 2.0, -3.0 ] ); var y = zerosLike( x ); var out = cumin.assign( x, y ); -// returns - -var v = ndarray2array( out ); -// returns [ -1.0, -1.0, -3.0 ] +// returns [ -1.0, -1.0, -3.0 ] var bool = ( out === y ); // returns true diff --git a/lib/node_modules/@stdlib/stats/cumin/docs/repl.txt b/lib/node_modules/@stdlib/stats/cumin/docs/repl.txt index 994a0b2f54fd..5b674cceddff 100644 --- a/lib/node_modules/@stdlib/stats/cumin/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/cumin/docs/repl.txt @@ -26,9 +26,8 @@ Examples -------- > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] ); - > var y = {{alias}}( x ); - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ -1.0, -1.0, -3.0, -4.0 ] + > var y = {{alias}}( x ) + [ -1.0, -1.0, -3.0, -4.0 ] {{alias}}.assign( x, out[, options] ) @@ -61,11 +60,9 @@ > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] ); > var out = {{alias:@stdlib/ndarray/zeros-like}}( x ); > var y = {{alias}}.assign( x, out ) - + [ -1.0, -1.0, -3.0, -4.0 ] > var bool = ( out === y ) true - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ -1.0, -1.0, -3.0, -4.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/stats/cumin/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/cumin/docs/types/index.d.ts index cb0559a57fb6..0b2d5f7d043e 100644 --- a/lib/node_modules/@stdlib/stats/cumin/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/cumin/docs/types/index.d.ts @@ -65,16 +65,12 @@ interface Unary { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var array = require( '@stdlib/ndarray/array' ); * * var x = array( [ -1.0, 2.0, -3.0 ] ); * * var y = cumin( x ); - * // returns - * - * var arr = ndarray2array( y ); - * // returns [ -1.0, -1.0, -3.0 ] + * // returns [ -1.0, -1.0, -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`. @@ -87,7 +83,6 @@ interface Unary { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var zerosLike = require( '@stdlib/ndarray/zeros-like' ); * var array = require( '@stdlib/ndarray/array' ); * @@ -95,13 +90,10 @@ interface Unary { * var y = zerosLike( x ); * * var out = cumin.assign( x, y ); - * // returns + * // returns [ -1.0, -1.0, -3.0 ] * * var bool = ( out === y ); * // returns true - * - * var arr = ndarray2array( out ); - * // returns [ -1.0, -1.0, -3.0 ] */ assign = OutputArray>( x: InputArray, out: U, options?: BaseOptions ): U; } @@ -114,19 +106,14 @@ interface Unary { * @returns output ndarray * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var array = require( '@stdlib/ndarray/array' ); * * var x = array( [ -1.0, 2.0, -3.0 ] ); * * var y = cumin( x ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ -1.0, -1.0, -3.0 ] +* // returns [ -1.0, -1.0, -3.0 ] * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var zerosLike = require( '@stdlib/ndarray/zeros-like' ); * var array = require( '@stdlib/ndarray/array' ); * @@ -134,13 +121,10 @@ interface Unary { * var y = zerosLike( x ); * * var out = cumin.assign( x, y ); -* // returns +* // returns [ -1.0, -1.0, -3.0 ] * * var bool = ( out === y ); * // returns true -* -* var arr = ndarray2array( out ); -* // returns [ -1.0, -1.0, -3.0 ] */ declare const cumin: Unary; diff --git a/lib/node_modules/@stdlib/stats/cumin/lib/index.js b/lib/node_modules/@stdlib/stats/cumin/lib/index.js index 5d325f20fae1..cc746e1a4d48 100644 --- a/lib/node_modules/@stdlib/stats/cumin/lib/index.js +++ b/lib/node_modules/@stdlib/stats/cumin/lib/index.js @@ -26,7 +26,6 @@ * @example * var Float64Array = require( '@stdlib/array/float64' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var cumin = require( '@stdlib/stats/cumin' ); * * // Create a data buffer: @@ -46,10 +45,7 @@ * * // Perform operation: * var out = cumin( x ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ [ [ 1.0, 1.0 ] ], [ [ -3.0, -3.0 ] ], [ [ -5.0, -5.0 ] ] ] +* // returns [ [ [ 1.0, 1.0 ] ], [ [ -3.0, -3.0 ] ], [ [ -5.0, -5.0 ] ] ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/stats/cumin/lib/main.js b/lib/node_modules/@stdlib/stats/cumin/lib/main.js index d27d261abcd5..91dbe8815350 100644 --- a/lib/node_modules/@stdlib/stats/cumin/lib/main.js +++ b/lib/node_modules/@stdlib/stats/cumin/lib/main.js @@ -70,7 +70,6 @@ var table = { * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * * // Create a data buffer: @@ -90,10 +89,7 @@ var table = { * * // Perform operation: * var out = cumin( x ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ [ [ 1.0, 1.0 ] ], [ [ -3.0, -3.0 ] ], [ [ -5.0, -5.0 ] ] ] +* // returns [ [ [ 1.0, 1.0 ] ], [ [ -3.0, -3.0 ] ], [ [ -5.0, -5.0 ] ] ] */ var cumin = factory( table, [ idtypes ], odtypes, policies );