About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

gfindIndex

Return the index of the first element which passes a test implemented by a predicate function.

Installation

npm install @stdlib/blas-ext-base-gfind-index

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var gfindIndex = require( '@stdlib/blas-ext-base-gfind-index' );

gfindIndex( N, x, strideX, clbk[, thisArg] )

Returns the index of the first element which passes a test implemented by a predicate function.

function isEven( v ) {
    return v % 2.0 === 0.0;
}

var x = [ 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];

var idx = gfindIndex( x.length, x, 1, isEven );
// returns 3

If no element passes a test implemented by a predicate function, the function returns -1.

function isEven( v ) {
    return v % 2.0 === 0.0;
}

var x = [ 1.0, 3.0, 5.0, 7.0, 9.0 ];

var idx = gfindIndex( x.length, x, 1, isEven );
// returns -1

The function has the following parameters:

• N: number of indexed elements.
• x: input array.
• strideX: stride length.
• clbk: callback function.
• thisArg: execution context (optional).

The callback function is provided the following arguments:

• value: current array element.
• aidx: array index.
• sidx: strided index (offset + aidx*stride).
• array: the input array.

To set the callback execution context, provide a thisArg.

function isEven( v ) {
    this.count += 1;
    return v % 2.0 === 0.0;
}

var x = [ 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];

var ctx = {
    'count': 0
};

var idx = gfindIndex( x.length, x, 1, isEven, ctx );
// returns 3

var count = ctx.count;
// returns 4

The N and stride parameters determine which elements in the strided array are accessed at runtime. For example, to test every other element:

function isEven( v ) {
    return v % 2.0 === 0.0;
}

var x = [ 1.0, 3.0, -5.0, 0.0, 4.0, -1.0, -3.0 ];

var idx = gfindIndex( 4, x, 2, isEven );
// returns 2

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Float64Array = require( '@stdlib/array-float64' );

function isEven( v ) {
    return v % 2.0 === 0.0;
}

// Initial array:
var x0 = new Float64Array( [ 1.0, 3.0, 4.0, -5.0, 7.0, 6.0 ] );

// Create an offset view:
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var idx = gfindIndex( 3, x1, 2, isEven );
// returns 2

gfindIndex.ndarray( N, x, strideX, offsetX, clbk[, thisArg] )

Returns the index of the first element which passes a test implemented by a predicate function using alternative indexing semantics.

function isEven( v ) {
    return v % 2.0 === 0.0;
}

var x = [ 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];

var idx = gfindIndex.ndarray( x.length, x, 1, 0, isEven );
// returns 3

The function has the following additional parameters:

• offsetX: starting index.

While typed array views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements:

function isEven( v ) {
    return v % 2.0 === 0.0;
}

var x = [ 1.0, -2.0, -4.0, 5.0, -7.0, 6.0 ];

var idx = gfindIndex.ndarray( 3, x, 1, x.length-3, isEven );
// returns 2

Notes

• If N <= 0, both functions return -1.
• Both functions support array-like objects having getter and setter accessors for array element access (e.g., @stdlib/array-base/accessor).

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var gfindIndex = require( '@stdlib/blas-ext-base-gfind-index' );

function isEven( v ) {
    return v % 2.0 === 0.0;
}

var x = discreteUniform( 10, -100, 100, {
    'dtype': 'generic'
});
console.log( x );

var idx = gfindIndex( x.length, x, 1, isEven );
console.log( idx );

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.