Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 243x 243x 243x 243x 243x 243x 243x 243x 121x 121x 122x 122x 243x 1x 1x 121x 121x 121x 121x 121x 121x 121x 121x 121x 243x 5x 5x 116x 116x 116x 116x 55x 116x 35x 35x 35x 81x 81x 56x 36x 36x 20x 20x 85x 85x 243x 39x 243x 46x 46x 83x 243x 20x 243x 63x 63x 77x 243x 12x 243x 49x 65x 16x 16x 55x 55x 243x 3x 3x 3x 3x 3x | /**
* @license Apache-2.0
*
* Copyright (c) 2025 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 hasOwnProp = require( '@stdlib/assert/has-own-property' );
var objectAssign = require( '@stdlib/object/assign' );
var isObject = require( '@stdlib/assert/is-object' );
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var broadcastScalar = require( '@stdlib/ndarray/base/broadcast-scalar' );
var maybeBroadcastArray = require( '@stdlib/ndarray/base/maybe-broadcast-array' );
var getDType = require( '@stdlib/ndarray/dtype' );
var getShape = require( '@stdlib/ndarray/shape' );
var getOrder = require( '@stdlib/ndarray/order' );
var format = require( '@stdlib/string/format' );
var defaults = require( '@stdlib/ndarray/defaults' );
var nonCoreShape = require( './non_core_shape.js' );
var base = require( './base.js' );
// VARIABLES //
var DEFAULT_DTYPE = defaults.get( 'dtypes.integer_index' );
// MAIN //
/**
* Returns the first index of a specified search element along one or more ndarray dimensions.
*
* @name indexOf
* @type {Function}
* @param {ndarrayLike} x - input ndarray
* @param {(ndarrayLike|*)} searchElement - search element
* @param {(ndarrayLike|integer)} [fromIndex] - index from which to begin searching
* @param {Options} [options] - function options
* @param {IntegerArray} [options.dims] - list of dimensions over which to perform operation
* @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
* @param {string} [options.dtype] - output ndarray data type
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} the function must be provided at least two arguments
* @throws {TypeError} third argument must be either an ndarray-like object or an integer
* @throws {TypeError} options argument must be an object
* @throws {RangeError} dimension indices must not exceed input ndarray bounds
* @throws {RangeError} number of dimension indices must not exceed the number of input ndarray dimensions
* @throws {Error} must provide valid options
* @returns {ndarray} output ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create a data buffer:
* var xbuf = new Float64Array( [ 1.0, 2.0, -3.0, 4.0, -5.0, 6.0 ] );
*
* // Define the shape of the input array:
* var sh = [ 3, 1, 2 ];
*
* // Define the array strides:
* var sx = [ 2, 2, 1 ];
*
* // Define the index offset:
* var ox = 0;
*
* // Create an input ndarray:
* var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
*
* // Find index:
* var out = indexOf( x, 4.0 );
* // returns <ndarray>
*
* var idx = out.get();
* // returns 3
*/
function indexOf( x, searchElement, fromIndex, options ) {
var nargs;
var opts;
var ord;
var dt;
var sh;
if ( !isndarrayLike( x ) ) {
throw new TypeError( format( 'invalid argument. The first argument must be an ndarray-like object. Value: `%s`.', x ) );
}
nargs = arguments.length;
if ( nargs < 2 ) {
throw new TypeError( format( 'invalid argument. The function must be provided at least two arguments. Value: `%s`.', nargs ) );
}
// Resolve input ndarray meta data:
dt = getDType( x );
ord = getOrder( x );
// Initialize options object:
opts = {};
// Case: indexOf( x, searchElement )
if ( nargs === 2 ) {
fromIndex = 0;
}
// Case: indexOf( x, searchElement, options )
else if (
nargs === 3 &&
!isndarrayLike( fromIndex ) &&
isObject( fromIndex )
) {
opts = objectAssign( opts, fromIndex );
fromIndex = 0;
}
// Case: indexOf( x, searchElement, fromIndex, options )
else if ( nargs === 4 ) {
if ( !isObject( options ) ) {
throw new TypeError( format( 'invalid argument. The fourth argument must be an object. Value: `%s`.', options ) );
}
opts = objectAssign( opts, options );
}
// Resolve shape for broadcasting
if ( hasOwnProp( opts, 'dims' ) ) {
sh = nonCoreShape( getShape( x ), opts.dims );
} else {
sh = [];
}
if ( isndarrayLike( searchElement ) ) {
searchElement = maybeBroadcastArray( searchElement, sh );
} else {
searchElement = broadcastScalar( searchElement, dt, sh, ord );
}
if ( isndarrayLike( fromIndex ) ) {
fromIndex = maybeBroadcastArray( fromIndex, sh );
} else if ( isInteger( fromIndex ) ) {
fromIndex = broadcastScalar( fromIndex, DEFAULT_DTYPE, sh, ord );
} else {
throw new TypeError( format( 'invalid argument. Third argument must be either an ndarray or an integer. Value: `%s`.', fromIndex ) );
}
return base( x, searchElement, fromIndex, opts );
}
// EXPORTS //
module.exports = indexOf;
|