diff --git a/lib/node_modules/@stdlib/blas/ext/index-of/README.md b/lib/node_modules/@stdlib/blas/ext/index-of/README.md index 3fa9337380f2..314fbe0a4d4a 100644 --- a/lib/node_modules/@stdlib/blas/ext/index-of/README.md +++ b/lib/node_modules/@stdlib/blas/ext/index-of/README.md @@ -43,10 +43,7 @@ var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // Perform operation: var out = indexOf( x, 2.0 ); -// returns - -var idx = out.get(); -// returns 1 +// returns [ 1 ] ``` The function has the following parameters: @@ -73,10 +70,7 @@ var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // Perform operation: var out = indexOf( x, 10.0 ); -// returns - -var idx = out.get(); -// returns -1 +// returns [ -1 ] ``` By default, the function begins searching from the first element along the reduction dimension. To begin searching from a different index, provide a `fromIndex` argument. @@ -90,16 +84,12 @@ var x = array( [ 1.0, 2.0, 3.0, 4.0, 2.0, 6.0 ] ); // Perform operation: var out = indexOf( x, 2.0, 2 ); -// returns - -var idx = out.get(); -// returns 4 +// returns [ 4 ] ``` By default, the function performs the operation over elements in the last dimension. To perform the operation over a different dimension, provide a `dim` 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 ] ] ); @@ -107,17 +97,13 @@ var x = array( [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] ); var out = indexOf( x, -3.0, { 'dim': 0 }); -// returns - -var idx = ndarray2array( out ); -// returns [ 1, -1 ] +// returns [ 1, -1 ] ``` 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 array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var x = array( [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] ); @@ -127,10 +113,7 @@ var opts = { }; var out = indexOf( x, -3.0, opts ); -// returns - -var idx = ndarray2array( out ); -// returns [ [ 1, -1 ] ] +// returns [ [ 1, -1 ] ] ``` 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. @@ -164,10 +147,7 @@ var y = zeros( [], { }); var out = indexOf.assign( x, 3.0, y ); -// returns - -var idx = out.get(); -// returns 2 +// returns [ 2 ] var bool = ( out === y ); // returns true diff --git a/lib/node_modules/@stdlib/blas/ext/index-of/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/index-of/docs/repl.txt index ab96c7bcfdf5..496461b6f4b1 100644 --- a/lib/node_modules/@stdlib/blas/ext/index-of/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/index-of/docs/repl.txt @@ -59,9 +59,8 @@ Examples -------- > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] ); - > var y = {{alias}}( x, 2.0 ); - > var v = y.get() - 1 + > var y = {{alias}}( x, 2.0 ) + [ 1 ] {{alias}}.assign( x, searchElement[, fromIndex], out[, options] ) @@ -122,11 +121,9 @@ > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] ); > var out = {{alias:@stdlib/ndarray/zeros}}( [], { 'dtype': 'int32' } ); > var y = {{alias}}.assign( x, 2.0, out ) - + [ 1 ] > var bool = ( out === y ) true - > var v = out.get() - 1 See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/index-of/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/index-of/docs/types/index.d.ts index a87ed9df9a34..e0f59a8ba709 100644 --- a/lib/node_modules/@stdlib/blas/ext/index-of/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/index-of/docs/types/index.d.ts @@ -95,10 +95,7 @@ interface IndexOf { * var x = array( [ -1.0, 2.0, -3.0 ] ); * * var y = indexOf( x, 2.0 ); - * // returns - * - * var idx = y.get(); - * // returns 1 + * // returns [ 1 ] */ ( x: InputArray, searchElement: SearchElement, options?: Options ): OutputArray; @@ -122,10 +119,7 @@ interface IndexOf { * var x = array( [ -1.0, 2.0, -3.0, 2.0, -5.0, 6.0 ] ); * * var y = indexOf( x, 2.0, 2 ); - * // returns - * - * var idx = y.get(); - * // returns 3 + * // returns [ 3 ] */ ( x: InputArray, searchElement: SearchElement, fromIndex: FromIndex, options?: Options ): OutputArray; @@ -153,13 +147,10 @@ interface IndexOf { * } ); * * var out = indexOf.assign( x, 2.0, y ); - * // returns + * // returns [ 1 ] * * var bool = ( out === y ); * // returns true - * - * var idx = out.get(); - * // returns 1 */ assign( x: InputArray, searchElement: SearchElement, out: U, options?: BaseOptions ): U; @@ -188,13 +179,10 @@ interface IndexOf { * } ); * * var out = indexOf.assign( x, 2.0, 2, y ); - * // returns + * // returns [ 3 ] * * var bool = ( out === y ); * // returns true - * - * var idx = out.get(); - * // returns 3 */ assign( x: InputArray, searchElement: SearchElement, fromIndex: FromIndex, out: U, options?: BaseOptions ): U; } @@ -219,10 +207,7 @@ interface IndexOf { * var x = array( [ -1.0, 2.0, -3.0 ] ); * * var y = indexOf( x, 2.0, 0 ); -* // returns -* -* var idx = y.get(); -* // returns 1 +* // returns [ 1 ] * * @example * var zeros = require( '@stdlib/ndarray/zeros' ); @@ -234,13 +219,10 @@ interface IndexOf { * } ); * * var out = indexOf.assign( x, 2.0, 2, y ); -* // returns +* // returns [ 3 ] * * var bool = ( out === y ); * // returns true -* -* var idx = out.get(); -* // returns 3 */ declare const indexOf: IndexOf; diff --git a/lib/node_modules/@stdlib/blas/ext/index-of/lib/assign.js b/lib/node_modules/@stdlib/blas/ext/index-of/lib/assign.js index b3e2e4e87a13..6c1626729a21 100644 --- a/lib/node_modules/@stdlib/blas/ext/index-of/lib/assign.js +++ b/lib/node_modules/@stdlib/blas/ext/index-of/lib/assign.js @@ -64,7 +64,6 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.integer_index' ); * @example * var Float64Array = require( '@stdlib/array/float64' ); * var zeros = require( '@stdlib/ndarray/zeros' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * * // Create data buffers: @@ -89,13 +88,10 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.integer_index' ); * * // Perform operation: * var out = assign( x, -5.0, y ); -* // returns +* // returns [ -1, 1 ] * * var bool = ( out === y ); * // returns true -* -* var arr = ndarray2array( out ); -* // returns [ -1, 1 ] */ function assign( x, searchElement, fromIndex, out ) { var hasOptions; diff --git a/lib/node_modules/@stdlib/blas/ext/index-of/lib/base.js b/lib/node_modules/@stdlib/blas/ext/index-of/lib/base.js index c5f9af5d5138..22bd2cc69728 100644 --- a/lib/node_modules/@stdlib/blas/ext/index-of/lib/base.js +++ b/lib/node_modules/@stdlib/blas/ext/index-of/lib/base.js @@ -107,10 +107,7 @@ var table = { * * // Perform operation: * var out = indexOf( x, searchElement, fromIndex ); -* // returns -* -* var idx = out.get(); -* // returns 3 +* // returns [ 4 ] */ var indexOf = factory( table, [ idtypes0, idtypes1, idtypes2 ], odtypes, policies ); // eslint-disable-line max-len diff --git a/lib/node_modules/@stdlib/blas/ext/index-of/lib/index.js b/lib/node_modules/@stdlib/blas/ext/index-of/lib/index.js index 6a29015f62f8..0189ba2191c8 100644 --- a/lib/node_modules/@stdlib/blas/ext/index-of/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/index-of/lib/index.js @@ -25,7 +25,6 @@ * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var indexOf = require( '@stdlib/blas/ext/index-of' ); * @@ -46,10 +45,7 @@ * * // Perform operation: * var out = indexOf( x, -5.0 ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ -1, 1 ] +* // returns [ -1, 1 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/ext/index-of/lib/main.js b/lib/node_modules/@stdlib/blas/ext/index-of/lib/main.js index 3f6da9fae8fa..d7ea6e9b3e4d 100644 --- a/lib/node_modules/@stdlib/blas/ext/index-of/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/index-of/lib/main.js @@ -63,7 +63,6 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.integer_index' ); * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * * // Create a data buffer: @@ -83,10 +82,7 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.integer_index' ); * * // Perform operation: * var out = indexOf( x, -5.0 ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ -1, 1 ] +* // returns [ -1, 1 ] */ function indexOf( x, searchElement, fromIndex ) { var hasOptions;