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
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
<!--

@license Apache-2.0

Copyright (c) 2026 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# gfindLastIndexBetween

> Return the index of the last element in a one-dimensional ndarray which passes a test implemented by a predicate function within a specified range.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var gfindLastIndexBetween = require( '@stdlib/blas/ext/base/ndarray/gfind-last-index-between' );
```

#### gfindLastIndexBetween( arrays, clbk\[, thisArg] )

Returns the index of the last element in a one-dimensional ndarray which passes a test implemented by a predicate function within a specified range.

```javascript
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var vector = require( '@stdlib/ndarray/vector/ctor' );

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

var x = vector( [ 2.0, 1.0, 3.0, 4.0, 5.0 ], 'generic' );

var fromIndex = scalar2ndarray( 4, {
'dtype': 'generic'
});

var toIndex = scalar2ndarray( 1, {
'dtype': 'generic'
});

var idx = gfindLastIndexBetween( [ x, fromIndex, toIndex ], isEven );
// returns 3
```

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a zero-dimensional ndarray containing the index from which to begin searching.
- a zero-dimensional ndarray containing the index at which to stop searching (exclusive).

- **clbk**: callback function.

- **thisArg**: callback execution context (_optional_).

The callback function is provided the following arguments:

- **value**: current array element.
- **idx**: current array element index.
- **array**: the input ndarray.

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

```javascript
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var vector = require( '@stdlib/ndarray/vector/ctor' );

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

var x = vector( [ 2.0, 1.0, 3.0, 5.0, 7.0 ], 'generic' );

var fromIndex = scalar2ndarray( 4, {
'dtype': 'generic'
});

var toIndex = scalar2ndarray( 1, {
'dtype': 'generic'
});

var idx = gfindLastIndexBetween( [ x, fromIndex, toIndex ], isEven );
// returns -1
```

To set the callback execution context, provide a `thisArg`.

```javascript
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var vector = require( '@stdlib/ndarray/vector/ctor' );

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

var x = vector( [ 2.0, 1.0, 3.0, 4.0, 5.0 ], 'generic' );
var ctx = {
'count': 0
};

var fromIndex = scalar2ndarray( 4, {
'dtype': 'generic'
});

var toIndex = scalar2ndarray( 1, {
'dtype': 'generic'
});

var v = gfindLastIndexBetween( [ x, fromIndex, toIndex ], isEven, ctx );
// returns 3

var count = ctx.count;
// returns 2
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If provided an empty one-dimensional ndarray, the function returns `-1`.
- If a specified starting search index is negative, the function resolves the starting search index by counting backward from the last element (where `-1` refers to the last element).
- If a specified ending search index is negative, the function resolves the ending search index by counting backward from the last element (where `-1` refers to the last element).

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/discrete-uniform' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var gfindLastIndexBetween = require( '@stdlib/blas/ext/base/ndarray/gfind-last-index-between' );

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

var opts = {
'dtype': 'generic'
};

var x = discreteUniform( [ 10 ], -100, 100, opts );
console.log( ndarray2array( x ) );

var fromIndex = scalar2ndarray( 8, {
'dtype': 'generic'
});

var toIndex = scalar2ndarray( 2, {
'dtype': 'generic'
});

var idx = gfindLastIndexBetween( [ x, fromIndex, toIndex ], isEven );
console.log( idx );
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/uniform' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var gfindLastIndexBetween = require( './../lib' );


// VARIABLES //

var options = {
'dtype': 'generic'
};


// FUNCTIONS //

/**
* Callback function.
*
* @private
* @param {number} v - array element
* @returns {boolean} result
*/
function clbk( v ) {
return v < 0.0;
}

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var fromIndex;
var toIndex;
var x;

x = uniform( [ len ], 0.0, 100.0, options );
fromIndex = scalar2ndarray( len - 1, {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose this is consistent with find-last-index, but it is a bit awkward, as it requires users to think about the search region in reverse (right-to-left) instead of the more "natural" left-to-right.

'dtype': 'generic'
});
toIndex = scalar2ndarray( 0, {
'dtype': 'generic'
});
return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var v;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = gfindLastIndexBetween( [ x, fromIndex, toIndex ], clbk );
if ( isnan( v ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( v ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var len;
var min;
var max;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

main();
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@

{{alias}}( arrays, clbk[, thisArg] )
Returns the index of the last element in a one-dimensional ndarray which
passes a test implemented by a predicate function within a specified range.

If a specified starting search index is negative, the function resolves the
starting search index by counting backward from the last element (where `-1`
refers to the last element).

If a specified ending search index is negative, the function resolves the
ending search index by counting backward from the last element (where `-1`
refers to the last element).

If provided an empty ndarray or no element passes a test implemented by a
predicate function, the function returns `-1`.

The callback function is provided three arguments:

- value: current array element.
- index: current array index.
- array: the input ndarray.

Parameters
----------
arrays: ArrayLikeObject<ndarray>
Array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a zero-dimensional ndarray containing the index from which to begin
searching.
- a zero-dimensional ndarray containing the index at which to stop
searching (exclusive).

clbk: Function
Callback function.

thisArg: any (optional)
Callback execution context.

Returns
-------
out: integer
Index.

Examples
--------
> var x = {{alias:@stdlib/ndarray/vector/ctor}}( [ -2.0, 1.0, 3.0, 4.0 ], 'generic' );
> var i = {{alias:@stdlib/ndarray/from-scalar}}( 3, { 'dtype': 'generic' } );
> var j = {{alias:@stdlib/ndarray/from-scalar}}( 0, { 'dtype': 'generic' } );
> function f ( v ) { return v % 2.0 === 0.0; };
> {{alias}}( [ x, i, j ], f )
3

See Also
--------
Loading
Loading