indexOfSameValue

Return the index of the first element which equals a provided search element according to the SameValue Algorithm.

Installation

npm install @stdlib/array-base-index-of-same-value

Usage

var indexOfSameValue = require( '@stdlib/array-base-index-of-same-value' );

indexOfSameValue( x, searchElement, fromIndex )

Returns the index of the first element which equals a provided search element according to the SameValue Algorithm.

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

var idx = indexOfSameValue( x, 3, 0 );
// 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 = indexOfSameValue( x, 7, 0 );
// returns -1

To begin searching from specific index, provide a non-zero fromIndex argument.

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

var idx = indexOfSameValue( x, 2, 3 );
// returns 4

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 = indexOfSameValue( x, 2, -4 );
// returns 4

Notes

• The function performs a linear scan and returns immediately upon finding a match.
• When searching for a search element, the function checks for equality using the SameValue Algorithm as specified in ECMAScript 5. As a consequence, NaN values are considered equal, and -0 and +0 are considered distinct.

Examples

var indexOfSameValue = require( '@stdlib/array-base-index-of-same-value' );

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

var idx = indexOfSameValue( x, 'beep', 0 );
// returns 2

idx = indexOfSameValue( x, 'bop', 0 );
// returns -1

idx = indexOfSameValue( x, 'foo', 1 );
// returns 4

idx = indexOfSameValue( x, 'foo', -4 );
// returns 4

idx = indexOfSameValue( x, 'foo', 5 );
// 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-2026. The Stdlib Authors.