diff --git a/lib/node_modules/@stdlib/ndarray/every/README.md b/lib/node_modules/@stdlib/ndarray/every/README.md index f44842a2573c..13d720d0e10e 100644 --- a/lib/node_modules/@stdlib/ndarray/every/README.md +++ b/lib/node_modules/@stdlib/ndarray/every/README.md @@ -49,10 +49,7 @@ var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] ); // Perform reduction: var out = every( x ); -// returns - -var v = out.get(); -// returns true +// returns [ true ] ``` The function accepts the following arguments: @@ -69,7 +66,6 @@ By default, the function performs a reduction over all elements in a provided [` ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); // Create an input ndarray: var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] ); @@ -79,17 +75,13 @@ var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] ); var out = every( x, { 'dims': [ 1, 2 ] }); -// returns - -var v = ndarray2array( out ); -// returns [ true, true, true ] +// returns [ true, true, true ] ``` By default, the function returns an [`ndarray`][@stdlib/ndarray/ctor] having a shape matching only the non-reduced dimensions of the input [`ndarray`][@stdlib/ndarray/ctor] (i.e., the reduced dimensions are dropped). To include the reduced dimensions as singleton dimensions in the output [`ndarray`][@stdlib/ndarray/ctor], set the `keepdims` option to `true`. ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); // Create an input ndarray: var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] ); @@ -100,10 +92,7 @@ var out = every( x, { 'dims': [ 1, 2 ], 'keepdims': true }); -// returns - -var v = ndarray2array( out ); -// returns [ [ [ true ] ], [ [ true ] ], [ [ true ] ] ] +// returns [ [ [ true ] ], [ [ true ] ], [ [ true ] ] ] ``` #### every.assign( x, out\[, options] ) @@ -125,13 +114,10 @@ var y = empty( [], { // Perform reduction: var out = every.assign( x, y ); -// returns +// returns [ true ] var bool = ( out === y ); // returns true - -var v = y.get(); -// returns true ``` The function accepts the following arguments: @@ -149,7 +135,6 @@ By default, the function performs a reduction over all elements in a provided [` ```javascript var array = require( '@stdlib/ndarray/array' ); var empty = require( '@stdlib/ndarray/empty' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); // Create an input ndarray: var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] ); @@ -164,12 +149,10 @@ var y = empty( [ 3 ], { var out = every.assign( x, y, { 'dims': [ 1, 2 ] }); +// returns [ true, true, true ] var bool = ( out === y ); // returns true - -var v = ndarray2array( y ); -// returns [ true, true, true ] ``` diff --git a/lib/node_modules/@stdlib/ndarray/every/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/every/docs/repl.txt index 110915256bf0..e38f91032d38 100644 --- a/lib/node_modules/@stdlib/ndarray/every/docs/repl.txt +++ b/lib/node_modules/@stdlib/ndarray/every/docs/repl.txt @@ -29,15 +29,9 @@ -------- > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 1.0 ], [ 1.0, 1.0 ] ] ); > var y = {{alias}}( x ) - - > y.get() - true + [ true ] > y = {{alias}}( x, { 'keepdims': true } ) - - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ [ true ] ] - > y.get( 0, 0 ) - true + [ [ true ] ] {{alias}}.assign( x, y[, options] ) @@ -71,11 +65,9 @@ > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 1.0 ], [ 1.0, 1.0 ] ] ); > var y = {{alias:@stdlib/ndarray/from-scalar}}( false ); > var out = {{alias}}.assign( x, y ) - + [ true ] > var bool = ( out === y ) true - > y.get() - true See Also -------- diff --git a/lib/node_modules/@stdlib/ndarray/every/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/every/docs/types/index.d.ts index 9b9906324a3a..a1747addb6ab 100644 --- a/lib/node_modules/@stdlib/ndarray/every/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/every/docs/types/index.d.ts @@ -77,10 +77,7 @@ interface Every { * * // Perform reduction: * var out = every( x ); - * // returns - * - * var v = out.get(); - * // returns true + * // returns [ true ] */ ( x: ndarray, options?: Options ): boolndarray; @@ -120,10 +117,7 @@ interface Every { * * // Perform reduction: * var out = every.assign( x, y ); - * // returns - * - * var v = out.get(); - * // returns true + * // returns [ true ] */ assign( x: ndarray, y: T, options?: BaseOptions ): T; } @@ -158,10 +152,7 @@ interface Every { * * // Perform reduction: * var out = every( x ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] * * @example * var Float64Array = require( '@stdlib/array/float64' ); @@ -190,10 +181,7 @@ interface Every { * * // Perform reduction: * var out = every.assign( x, y ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] */ declare var every: Every; diff --git a/lib/node_modules/@stdlib/ndarray/every/lib/assign.js b/lib/node_modules/@stdlib/ndarray/every/lib/assign.js index 464df8fc0e9a..af5c2eee0198 100644 --- a/lib/node_modules/@stdlib/ndarray/every/lib/assign.js +++ b/lib/node_modules/@stdlib/ndarray/every/lib/assign.js @@ -73,10 +73,7 @@ var validate = require( './validate.js' ); * * // Perform reduction: * var out = assign( x, y ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] */ function assign( x, y, options ) { var opts; diff --git a/lib/node_modules/@stdlib/ndarray/every/lib/index.js b/lib/node_modules/@stdlib/ndarray/every/lib/index.js index dd00f7088032..d9b5a65f4dbc 100644 --- a/lib/node_modules/@stdlib/ndarray/every/lib/index.js +++ b/lib/node_modules/@stdlib/ndarray/every/lib/index.js @@ -45,10 +45,7 @@ * * // Perform reduction: * var out = every( x ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] * * @example * var Float64Array = require( '@stdlib/array/float64' ); @@ -78,10 +75,7 @@ * * // Perform reduction: * var out = every.assign( x, y ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/ndarray/every/lib/main.js b/lib/node_modules/@stdlib/ndarray/every/lib/main.js index de5076c363be..7b59fcfef080 100644 --- a/lib/node_modules/@stdlib/ndarray/every/lib/main.js +++ b/lib/node_modules/@stdlib/ndarray/every/lib/main.js @@ -78,10 +78,7 @@ var validate = require( './validate.js' ); * * // Perform reduction: * var out = every( x ); -* // returns -* -* var v = out.get(); -* // returns true +* // returns [ true ] */ function every( x, options ) { var opts;