@stdlib/array-base-last-index-of

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!

lastIndexOf

Return the index of the last element which equals a provided search element.

Installation

npm install @stdlib/array-base-last-index-of

Usage

var lastIndexOf = require( '@stdlib/array-base-last-index-of' );

lastIndexOf( x, searchElement, fromIndex, equalNaNs )

Returns the index of the last element which equals a provided search element.

var x = [ 1, 2, 3, 4, 5, 6 ];

var idx = lastIndexOf( x, 3, 5, false );
// returns 2

If the function is unable to find an element which equals a provided search element, the function returns -1.

var x = [ 1, 2, 3, 4, 5, 6 ];

var idx = lastIndexOf( x, 7, 5, false );
// returns -1

To begin searching from a specific index, provide a corresponding fromIndex argument.

var x = [ 1, 1, 2, 1, 2, 3, 3 ];

var idx = lastIndexOf( x, 2, 3, false );
// returns 2

If fromIndex is less than zero, the starting index is resolved relative to the last array element, with the last array element corresponding to fromIndex = -1.

var x = [ 1, 1, 2, 1, 2, 3, 3 ];

var idx = lastIndexOf( x, 2, -4, false );
// returns 2

When searching for a search element, the function checks for strict equality. As a consequence, NaN values are considered distinct. In order to resolve the last element which is NaN, set the equalNaNs argument to true.

var x = [ 1, 2, 3, NaN, 5, 6 ];

var idx = lastIndexOf( x, NaN, 5, false );
// returns -1

idx = lastIndexOf( x, NaN, 5, true );
// returns 3

Notes

• The function scans an input array from the starting index to the beginning of the array (i.e., backward).

• If provided an array-like object having a lastIndexOf method and equalNaNs is false, the function defers execution to that method and assumes that the method API has the following signature:

  x.lastIndexOf( searchElement, fromIndex )
  

• If provided an array-like object without a lastIndexOf method or if equalNaNs is true, the function performs a linear scan and returns immediately upon finding a match.

Examples

var lastIndexOf = require( '@stdlib/array-base-last-index-of' );

var x = [ 'foo', 'bar', 'beep', 'boop', 'foo', 'bar' ];

var idx = lastIndexOf( x, 'beep', 5, false );
// returns 2

idx = lastIndexOf( x, 'bop', 5, false );
// returns -1

idx = lastIndexOf( x, 'foo', 5, false );
// returns 4

idx = lastIndexOf( x, 'foo', -3, false );
// returns 0

idx = lastIndexOf( x, 'foo', -50, false );
// returns -1

---

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-2024. The Stdlib Authors.