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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 | 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 184x 184x 184x 184x 184x 184x 184x 184x 184x 184x 184x 184x 184x 184x 81x 81x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 103x 184x 11x 11x 8x 8x 11x 92x 92x 44x 44x 1x 1x 1x 43x 43x 2x 2x 2x 2x 41x 41x 1x 1x 1x 1x 1x 40x 40x 40x 40x 40x 14x 14x 26x 26x 44x 48x 48x 40x 40x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 13x 13x 2x 13x 3x 3x 11x 8x 8x 5x 5x 5x 7x 7x 7x 7x 7x 7x 7x 40x 8x 8x 8x 8x 8x 8x 8x 184x 51x 14x 14x 37x 51x 25x 25x 51x 1x 1x 51x 9x 9x 51x 184x 1x 1x 43x 43x 43x 43x 43x 184x 39x 184x 4x 4x 43x 184x 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 isFunction = require( '@stdlib/assert/is-function' );
var isPlainObject = require( '@stdlib/assert/is-plain-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 nonCoreShape = require( '@stdlib/ndarray/base/complement-shape' );
var getShape = require( '@stdlib/ndarray/shape' );
var getOrder = require( '@stdlib/ndarray/order' );
var ndims = require( '@stdlib/ndarray/ndims' );
var format = require( '@stdlib/string/format' );
var defaults = require( '@stdlib/ndarray/defaults' );
var base = require( './base.js' );
// VARIABLES //
var DEFAULT_DTYPE = defaults.get( 'dtypes.integer_index' );
// MAIN //
/**
* Returns the index of the first element along an ndarray dimension which passes a test implemented by a predicate function.
*
* @param {ndarrayLike} x - input ndarray
* @param {(ndarrayLike|integer)} [fromIndex=0] - index from which to begin searching
* @param {Options} [options] - function options
* @param {integer} [options.dim=-1] - dimension 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 {*} [options.dtype] - output ndarray data type
* @param {Function} clbk - callback function
* @param {*} [thisArg] - callback execution context
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} callback argument must be a function
* @throws {TypeError} options argument must be an object
* @throws {TypeError} `fromIndex` argument must be either an ndarray-like object or an integer
* @throws {RangeError} dimension index must not exceed input ndarray bounds
* @throws {RangeError} first argument must have at least one dimension
* @throws {Error} must provide valid options
* @returns {ndarray} output ndarray
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* function isEven( v ) {
* return v % 2.0 === 0.0;
* }
*
* // Create a data buffer:
* var xbuf = [ 1.0, 2.0, -3.0, 4.0, -5.0, 6.0 ];
*
* // Define the shape of the input array:
* var sh = [ 2, 3 ];
*
* // Define the array strides:
* var sx = [ 3, 1 ];
*
* // Define the index offset:
* var ox = 0;
*
* // Create an input ndarray:
* var x = new ndarray( 'generic', xbuf, sh, sx, ox, 'row-major' );
*
* // Perform operation:
* var out = findIndex( x, isEven );
* // returns <ndarray>[ 1, 0 ]
*/
function findIndex( x ) {
var hasOptions;
var options;
var nargs;
var opts;
var fidx;
var iflg;
var ord;
var ctx;
var sh;
var cb;
nargs = arguments.length;
if ( !isndarrayLike( x ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
}
// Resolve input ndarray meta data:
ord = getOrder( x );
// Initialize an options object:
opts = {
'dims': [ -1 ], // default behavior is to perform a reduction over the last dimension
'keepdims': false
};
// Initialize the `fromIndex` to the first element along a dimension:
fidx = 0;
// Initialize a flag indicating whether the `fromIndex` argument is a scalar:
iflg = true;
// Initialize a flag indicating whether an `options` argument was provided:
hasOptions = false;
// Case: findIndex( x, clbk )
if ( nargs <= 2 ) {
cb = arguments[ 1 ];
if ( !isFunction( cb ) ) {
throw new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', cb ) );
}
}
// Case: findIndex( x, ???, ??? )
else if ( nargs === 3 ) {
// Case: findIndex( x, clbk, thisArg )
if ( isFunction( arguments[ 1 ] ) ) {
cb = arguments[ 1 ];
ctx = arguments[ 2 ];
}
// Case: findIndex( x, from_index_scalar, clbk )
else if ( isInteger( arguments[ 1 ] ) ) {
fidx = arguments[ 1 ];
cb = arguments[ 2 ];
if ( !isFunction( cb ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be a function. Value: `%s`.', cb ) );
}
}
// Case: findIndex( x, from_index_ndarray, clbk )
else if ( isndarrayLike( arguments[ 1 ] ) ) {
fidx = arguments[ 1 ];
iflg = false;
cb = arguments[ 2 ];
if ( !isFunction( cb ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be a function. Value: `%s`.', cb ) );
}
}
// Case: findIndex( x, options, clbk )
else {
options = arguments[ 1 ];
cb = arguments[ 2 ];
if ( !isFunction( cb ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be a function. Value: `%s`.', cb ) );
}
hasOptions = true;
}
}
// Case: findIndex( x, ???, ???, ??? )
else if ( nargs === 4 ) {
// Case: findIndex( x, from_index, clbk, thisArg ) or findIndex( x, options, clbk, thisArg )
if ( isFunction( arguments[ 2 ] ) ) {
cb = arguments[ 2 ];
ctx = arguments[ 3 ];
if ( isInteger( arguments[ 1 ] ) ) {
fidx = arguments[ 1 ];
} else if ( isndarrayLike( arguments[ 1 ] ) ) {
fidx = arguments[ 1 ];
iflg = false;
} else {
options = arguments[ 1 ];
hasOptions = true;
}
}
// Case: findIndex( x, from_index, options, clbk )
else if ( isFunction( arguments[ 3 ] ) ) {
cb = arguments[ 3 ];
if ( isInteger( arguments[ 1 ] ) ) {
fidx = arguments[ 1 ];
} else if ( isndarrayLike( arguments[ 1 ] ) ) {
fidx = arguments[ 1 ];
iflg = false;
} else {
throw new TypeError( format( 'invalid argument. Second argument must be either an ndarray or an integer. Value: `%s`.', arguments[ 1 ] ) );
}
options = arguments[ 2 ];
hasOptions = true;
}
// Case: findIndex( x, options, clbk, thisArg )
else {
options = arguments[ 1 ];
cb = arguments[ 2 ];
if ( !isFunction( cb ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be a function. Value: `%s`.', cb ) );
}
ctx = arguments[ 3 ];
hasOptions = true;
}
}
// Case: findIndex( x, from_index, options, clbk, thisArg )
else {
if ( isInteger( arguments[ 1 ] ) ) {
fidx = arguments[ 1 ];
} else if ( isndarrayLike( arguments[ 1 ] ) ) {
fidx = arguments[ 1 ];
iflg = false;
} else {
throw new TypeError( format( 'invalid argument. Second argument must be either an ndarray or an integer. Value: `%s`.', arguments[ 1 ] ) );
}
options = arguments[ 2 ];
cb = arguments[ 3 ];
ctx = arguments[ 4 ];
if ( !isFunction( cb ) ) {
throw new TypeError( format( 'invalid argument. Fourth argument must be a function. Value: `%s`.', cb ) );
}
hasOptions = true;
}
if ( hasOptions ) {
if ( !isPlainObject( options ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
// Resolve provided options...
if ( hasOwnProp( options, 'dim' ) ) {
opts.dims[ 0 ] = options.dim;
}
if ( hasOwnProp( options, 'keepdims' ) ) {
opts.keepdims = options.keepdims;
}
if ( hasOwnProp( options, 'dtype' ) ) {
opts.dtype = options.dtype;
}
}
if ( ndims( x ) < 1 ) {
throw new RangeError( 'invalid argument. First argument must have at least one dimension.' );
}
// Resolve the list of non-reduced dimensions:
sh = getShape( x );
sh = nonCoreShape( sh, opts.dims );
// Broadcast the `fromIndex` to match the shape of the non-reduced dimensions...
if ( iflg ) {
fidx = broadcastScalar( fidx, DEFAULT_DTYPE, sh, ord );
} else {
fidx = maybeBroadcastArray( fidx, sh );
}
return base( x, fidx, opts, cb, ctx );
}
// EXPORTS //
module.exports = findIndex;
|