Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 7 additions & 27 deletions lib/node_modules/@stdlib/blas/ext/find-index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,7 @@ var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );

// Perform operation:
var out = findIndex( x, isEven );
// returns <ndarray>

var idx = out.get();
// returns 1
// returns <ndarray>[ 1 ]
```

The function has the following parameters:
Expand Down Expand Up @@ -84,10 +81,7 @@ var ctx = {
'count': 0
};
var out = findIndex( x, isEven, ctx );
// returns <ndarray>

var idx = out.get();
// returns 1
// returns <ndarray>[ 1 ]

var count = ctx.count;
// returns 2
Expand All @@ -114,16 +108,12 @@ var x = array( [ 1.0, 3.0, 5.0, 7.0 ] );

// Perform operation:
var out = findIndex( x, isEven );
// returns <ndarray>

var idx = out.get();
// returns -1
// returns <ndarray>[ -1 ]
```

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' );

function isEven( v ) {
Expand All @@ -137,17 +127,13 @@ var opts = {
};

var out = findIndex( x, opts, isEven );
// returns <ndarray>

var idx = ndarray2array( out );
// returns [ -1, 0 ]
// returns <ndarray>[ -1, 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 array = require( '@stdlib/ndarray/array' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );

function isEven( v ) {
return v % 2.0 === 0.0;
Expand All @@ -161,10 +147,7 @@ var opts = {
};

var out = findIndex( x, opts, isEven );
// returns <ndarray>

var idx = ndarray2array( out );
// returns [ [ -1, 0 ] ]
// returns <ndarray>[ [ -1, 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.
Expand All @@ -184,7 +167,7 @@ var opts = {
};

var idx = findIndex( x, opts, isEven );
// returns <ndarray>
// returns <ndarray>[ 1 ]

var dt = dtype( idx );
// returns 'generic'
Expand All @@ -208,10 +191,7 @@ var y = zeros( [], {
});

var out = findIndex.assign( x, y, isEven );
// returns <ndarray>

var idx = out.get();
// returns 1
// returns <ndarray>[ 1 ]

var bool = ( out === y );
// returns true
Expand Down
9 changes: 3 additions & 6 deletions lib/node_modules/@stdlib/blas/ext/find-index/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,8 @@
--------
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
> function clbk( v ) { return v % 2.0 === 0.0; };
> var y = {{alias}}( x, clbk );
> var v = y.get()
1
> var y = {{alias}}( x, clbk )
<ndarray>[ 1 ]


{{alias}}.assign( x, out[, options], clbk[, thisArg] )
Expand Down Expand Up @@ -107,11 +106,9 @@
> var out = {{alias:@stdlib/ndarray/zeros}}( [] );
> function clbk( v ) { return v % 2.0 === 0.0; };
> var y = {{alias}}.assign( x, out, clbk )
<ndarray>
<ndarray>[ 1 ]
> var bool = ( out === y )
true
> var v = out.get()
1

See Also
--------
Expand Down
30 changes: 6 additions & 24 deletions lib/node_modules/@stdlib/blas/ext/find-index/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,7 @@ interface FindIndex {
* var x = array( [ -1.0, 2.0, -3.0 ] );
*
* var y = findIndex( x, clbk );
* // returns <ndarray>
*
* var v = y.get();
* // returns 1
* // returns <ndarray>[ 1 ]
*/
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, clbk: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): OutputArray;

Expand All @@ -161,10 +158,7 @@ interface FindIndex {
* var x = array( [ -1.0, 2.0, -3.0 ] );
*
* var y = findIndex( x, {}, clbk );
* // returns <ndarray>
*
* var v = y.get();
* // returns 1
* // returns <ndarray>[ 1 ]
*/
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, options: Options, clbk: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): OutputArray;

Expand Down Expand Up @@ -193,10 +187,7 @@ interface FindIndex {
* var y = zeros( [] );
*
* var out = findIndex.assign( x, y, clbk );
* // returns <ndarray>
*
* var v = out.get();
* // returns 1
* // returns <ndarray>[ 1 ]
*
* var bool = ( out === y );
* // returns true
Expand Down Expand Up @@ -229,10 +220,7 @@ interface FindIndex {
* var y = zeros( [] );
*
* var out = findIndex.assign( x, y, {}, clbk );
* // returns <ndarray>
*
* var v = out.get();
* // returns 1
* // returns <ndarray>[ 1 ]
*
* var bool = ( out === y );
* // returns true
Expand Down Expand Up @@ -263,10 +251,7 @@ interface FindIndex {
* var x = array( [ -1.0, 2.0, -3.0 ] );
*
* var y = findIndex( x, clbk );
* // returns <ndarray>
*
* var v = y.get();
* // returns 1
* // returns <ndarray>[ 1 ]
*
* @example
* var array = require( '@stdlib/ndarray/array' );
Expand All @@ -280,10 +265,7 @@ interface FindIndex {
* var y = zeros( [] );
*
* var out = findIndex.assign( x, y, clbk );
* // returns <ndarray>
*
* var v = out.get();
* // returns 1
* // returns <ndarray>[ 1 ]
*
* var bool = ( out === y );
* // returns true
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/blas/ext/find-index/lib/assign.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ var base = require( './base.js' ).assign;
*
* @example
* var zeros = require( '@stdlib/ndarray/zeros' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* function isEven( v ) {
Expand Down Expand Up @@ -81,13 +80,10 @@ var base = require( './base.js' ).assign;
*
* // Perform operation:
* var out = assign( x, y, isEven );
* // returns <ndarray>
* // returns <ndarray>[ 1, 0 ]
*
* var bool = ( out === y );
* // returns true
*
* var arr = ndarray2array( out );
* // returns [ 1, 0 ]
*/
function assign( x, out ) {
var hasOptions;
Expand Down
5 changes: 1 addition & 4 deletions lib/node_modules/@stdlib/blas/ext/find-index/lib/base.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,7 @@ var table = {
*
* // Perform operation:
* var out = findIndex( x, isEven );
* // returns <ndarray>
*
* var idx = out.get();
* // returns 1
* // returns <ndarray>[ 1 ]
*/
var findIndex = factory( table, [ idtypes ], odtypes, policies );

Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/blas/ext/find-index/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
* @module @stdlib/blas/ext/find-index
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var findIndex = require( '@stdlib/blas/ext/find-index' );
*
Expand All @@ -49,10 +48,7 @@
*
* // Perform operation:
* var out = findIndex( x, isEven );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ 1, 0 ]
* // returns <ndarray>[ 1, 0 ]
*/

// MODULES //
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/blas/ext/find-index/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ var base = require( './base.js' );
* @returns {ndarray} output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* function isEven( v ) {
Expand All @@ -74,10 +73,7 @@ var base = require( './base.js' );
*
* // Perform operation:
* var out = findIndex( x, isEven );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ 1, 0 ]
* // returns <ndarray>[ 1, 0 ]
*/
function findIndex( x ) {
var hasOptions;
Expand Down