diff --git a/lib/node_modules/@stdlib/math/special/abs/README.md b/lib/node_modules/@stdlib/math/special/abs/README.md index 3b430e11ccf8..3aaf4608624b 100644 --- a/lib/node_modules/@stdlib/math/special/abs/README.md +++ b/lib/node_modules/@stdlib/math/special/abs/README.md @@ -45,15 +45,11 @@ var abs = require( '@stdlib/math/special/abs' ); Computes the [absolute value][@stdlib/math/base/special/abs] for each element in an [ndarray][@stdlib/ndarray/ctor]. ```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 ] ] ); var y = abs( x ); -// returns - -var arr = ndarray2array( y ); -// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] +// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ``` The function accepts the following arguments: @@ -69,7 +65,6 @@ The function accepts the following options: 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. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var array = require( '@stdlib/ndarray/array' ); var getDType = require( '@stdlib/ndarray/dtype' ); @@ -77,19 +72,15 @@ var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ); var y = abs( x, { 'dtype': 'generic' }); -// returns +// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] var dt = getDType( y ); // returns 'generic' - -var arr = ndarray2array( y ); -// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ``` By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having the same [order][@stdlib/ndarray/orders] as the input [ndarray][@stdlib/ndarray/ctor]. To return an [ndarray][@stdlib/ndarray/ctor] having a specific memory layout irrespective of the memory layout of the input [ndarray][@stdlib/ndarray/ctor], set the `order` option. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var array = require( '@stdlib/ndarray/array' ); var getOrder = require( '@stdlib/ndarray/order' ); @@ -97,13 +88,10 @@ var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ); var y = abs( x, { 'order': 'column-major' }); -// returns +// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] var ord = getOrder( y ); // returns 'column-major' - -var arr = ndarray2array( y ); -// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ``` #### abs.assign( x, y ) @@ -111,20 +99,16 @@ var arr = ndarray2array( y ); Computes the [absolute value][@stdlib/math/base/special/abs] for each element in an [ndarray][@stdlib/ndarray/ctor] 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 x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ); var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ); var out = abs.assign( x, y ); -// returns +// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] var bool = ( out === y ); // returns true - -var arr = ndarray2array( out ); -// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ``` The function accepts the following arguments: @@ -135,7 +119,6 @@ The function accepts the following arguments: The function supports broadcasting an input [ndarray][@stdlib/ndarray/ctor] to the shape of the output [ndarray][@stdlib/ndarray/ctor] without performing a physical copy of the input [ndarray][@stdlib/ndarray/ctor]'s underlying data. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var zeros = require( '@stdlib/ndarray/zeros' ); var array = require( '@stdlib/ndarray/array' ); @@ -146,10 +129,7 @@ var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ); var y = zeros( [ 2, 2, 2 ] ); var out = abs.assign( x, y ); -// returns - -var arr = ndarray2array( out ); -// returns [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] +// returns [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ``` diff --git a/lib/node_modules/@stdlib/math/special/abs/docs/repl.txt b/lib/node_modules/@stdlib/math/special/abs/docs/repl.txt index 13f1271d98fe..9c87e9258133 100644 --- a/lib/node_modules/@stdlib/math/special/abs/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/special/abs/docs/repl.txt @@ -29,9 +29,8 @@ -------- > var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ]; > var x = {{alias:@stdlib/ndarray/array}}( arr ); - > var y = {{alias}}( x ); - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] + > var y = {{alias}}( x ) + [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] {{alias}}.assign( x, y ) @@ -57,11 +56,10 @@ > var x = {{alias:@stdlib/ndarray/array}}( arr ); > var sh = {{alias:@stdlib/ndarray/shape}}( x ); > var y = {{alias:@stdlib/ndarray/zeros}}( sh ); - > var out = {{alias}}.assign( x, y ); + > var out = {{alias}}.assign( x, y ) + [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] > var bool = ( out === y ) true - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/special/abs/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/special/abs/docs/types/index.d.ts index 4ee99acfa7cc..aa9368cd05b2 100644 --- a/lib/node_modules/@stdlib/math/special/abs/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/special/abs/docs/types/index.d.ts @@ -63,17 +63,13 @@ interface UnaryFunction { * @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, 4.0 ] ] ); * // returns * * var y = abs( x ); - * // returns - * - * var arr = ndarray2array( y ); - * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] + * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] */ ( x: InputArray, options?: Options ): typedndarray; // FIXME: we lose type specificity here, as the output ndarray data type is determined according to the output data type policy in conjunction with the `dtype` option @@ -85,20 +81,16 @@ interface UnaryFunction { * @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, -4.0 ] ] ); * var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ); * * var z = abs.assign( x, y ); - * // returns + * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] * * var bool = ( z === y ); * // returns true - * - * var arr = ndarray2array( y ); - * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] */ assign( x: InputArray, y: T ): T; } @@ -111,16 +103,12 @@ interface UnaryFunction { * @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, -4.0 ] ] ); * * var y = abs( x ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] * * @example * var ndarray2array = require( '@stdlib/ndarray/to-array' ); @@ -130,13 +118,10 @@ interface UnaryFunction { * var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ); * * var z = abs.assign( x, y ); -* // returns +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] * * var bool = ( z === y ); * // returns true -* -* var arr = ndarray2array( y ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] */ declare var abs: UnaryFunction; diff --git a/lib/node_modules/@stdlib/math/special/abs/lib/index.js b/lib/node_modules/@stdlib/math/special/abs/lib/index.js index 740c2f23785e..1291861274af 100644 --- a/lib/node_modules/@stdlib/math/special/abs/lib/index.js +++ b/lib/node_modules/@stdlib/math/special/abs/lib/index.js @@ -24,7 +24,6 @@ * @module @stdlib/math/special/abs * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var array = require( '@stdlib/ndarray/array' ); * var abs = require( '@stdlib/math/special/abs' ); * @@ -32,10 +31,7 @@ * // returns * * var y = abs( x ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/special/abs/lib/main.js b/lib/node_modules/@stdlib/math/special/abs/lib/main.js index 90bd64aba39b..94b028aafdf5 100644 --- a/lib/node_modules/@stdlib/math/special/abs/lib/main.js +++ b/lib/node_modules/@stdlib/math/special/abs/lib/main.js @@ -48,17 +48,13 @@ var config = require( './config.js' ); * @returns {ndarray} 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, 4.0 ] ] ); * // returns * * var y = abs( x ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] */ var abs = ufunc( dispatch( unary, types, data, config.nargs, config.nin, config.nout ), [ config.idtypes ], config.odtypes, config.policies ); setProps( config, types, abs ); diff --git a/lib/node_modules/@stdlib/math/special/abs/lib/native.js b/lib/node_modules/@stdlib/math/special/abs/lib/native.js index 4bb5ef265506..8cd82ed9c03e 100644 --- a/lib/node_modules/@stdlib/math/special/abs/lib/native.js +++ b/lib/node_modules/@stdlib/math/special/abs/lib/native.js @@ -48,17 +48,13 @@ var fallback = require( './main.js' ).assign; * @returns {ndarray} 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, 4.0 ] ] ); * // returns * * var y = abs( x ); -* // returns -* -* var arr = ndarray2array( y ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] */ var abs = ufunc( dispatch( addon, fallback ), [ config.idtypes ], config.odtypes, config.policies ); setProps( config, types, abs );