@stdlib/array/base/index-of/lib/main.js

Arrays.

/**
* @license Apache-2.0
*
* Copyright (c) 2023 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 arraylike2object = require( './../../../base/arraylike2object' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );


// FUNCTIONS //

/**
* Tests whether an object has a specified method.
*
* @private
* @param {Object} obj - input object
* @param {string} method - method name
* @returns {boolean} boolean indicating whether an object has a specified method
*
* @example
* var bool = hasMethod( [], 'indexOf' );
* // returns true
*
* @example
* var bool = hasMethod( [], 'beep' );
* // returns false
*/
function hasMethod( obj, method ) {
	return ( typeof obj[ method ] === 'function' );
}

/**
* Returns the index of the first element which equals a provided search element.
*
* @private
* @param {Collection} x - input array
* @param {*} searchElement - search element
* @param {NonNegativeInteger} fromIndex - starting index (inclusive)
* @param {boolean} equalNaNs - boolean indicating whether NaNs should be considered equal
* @returns {integer} index
*
* @example
* var x = [ 1, 2, 3, 4 ];
*
* var idx = internal( x, 2, 0, false );
* // returns 1
*/
function internal( x, searchElement, fromIndex, equalNaNs ) {
	var i;
	if ( equalNaNs && isnan( searchElement ) ) {
		for ( i = fromIndex; i < x.length; i++ ) {
			if ( isnan( x[ i ] ) ) {
				return i;
			}
		}
		return -1;
	}
	for ( i = fromIndex; i < x.length; i++ ) {
		if ( searchElement === x[ i ] ) {
			return i;
		}
	}
	return -1;
}

/**
* Returns the index of the first element which equals a provided search element.
*
* @private
* @param {Object} x - input array object
* @param {*} searchElement - search element
* @param {NonNegativeInteger} fromIndex - starting index (inclusive)
* @param {boolean} equalNaNs - boolean indicating whether NaNs should be considered equal
* @returns {integer} index
*
* @example
* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
*
* var x = arraylike2object( toAccessorArray( [ 1, 2, 3, 4 ] ) );
*
* var idx = accessors( x, 2, 0, false );
* // returns 1
*/
function accessors( x, searchElement, fromIndex, equalNaNs ) {
	var data;
	var get;
	var i;

	data = x.data;
	get = x.accessors[ 0 ];

	if ( equalNaNs && isnan( searchElement ) ) {
		for ( i = fromIndex; i < data.length; i++ ) {
			if ( isnan( get( data, i ) ) ) {
				return i;
			}
		}
		return -1;
	}
	for ( i = fromIndex; i < data.length; i++ ) {
		if ( searchElement === get( data, i ) ) {
			return i;
		}
	}
	return -1;
}


// MAIN //

/**
* Returns the index of the first element which equals a provided search element.
*
* ## Notes
*
* -   If unable to find an element which equals a provided search element, the function returns `-1`.
*
* @param {Collection} x - input array
* @param {*} searchElement - search element
* @param {integer} fromIndex - starting index (inclusive)
* @param {boolean} equalNaNs - boolean indicating whether NaNs should be considered equal
* @returns {integer} index
*
* @example
* var x = [ 1, 2, 3, 4 ];
*
* var idx = indexOf( x, 2, 0, false );
* // returns 1
*
* @example
* var Int32Array = require( '@stdlib/array/int32' );
*
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
*
* var idx = indexOf( x, 2, 0, false );
* // returns 1
*/
function indexOf( x, searchElement, fromIndex, equalNaNs ) {
	var obj;
	if ( hasMethod( x, 'indexOf' ) && equalNaNs === false ) {
		return x.indexOf( searchElement, fromIndex );
	}
	if ( fromIndex < 0 ) {
		fromIndex += x.length;
		if ( fromIndex < 0 ) {
			fromIndex = 0;
		}
	}
	obj = arraylike2object( x );
	if ( obj.accessorProtocol ) {
		return accessors( obj, searchElement, fromIndex, equalNaNs );
	}
	return internal( x, searchElement, fromIndex, equalNaNs );
}


// EXPORTS //

module.exports = indexOf;