All files base.js

100% Statements 104/104
100% Branches 1/1
100% Functions 0/0
100% Lines 104/104

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 1053x 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 3x 3x 3x 3x 3x 3x 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 dtypes = require( '@stdlib/ndarray/dtypes' );
var gfindIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-index' );
var factory = require( '@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-by-factory' );
 
 
// VARIABLES //
 
var idtypes0 = dtypes( 'all' ); // input ndarray
var idtypes1 = dtypes( 'integer_index_and_generic' ); // from index ndarray
var odtypes = dtypes( 'integer_index_and_generic' );
var policies = {
	'output': 'integer_index_and_generic',
	'casting': 'none'
};
var table = {
	'default': gfindIndex
};
 
 
// MAIN //
 
/**
* Returns the index of the first element along an ndarray dimension which passes a test implemented by a predicate function.
*
* @private
* @name findIndex
* @type {Function}
* @param {ndarrayLike} x - input ndarray
* @param {ndarrayLike} fromIndex - indices from which to begin searching
* @param {Options} [options] - function options
* @param {IntegerArray} [options.dims] - list of dimensions over which to perform operation
* @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} second argument must be an ndarray-like object
* @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 scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* 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 = [ 6 ];
*
* // Define the array strides:
* var sx = [ 1 ];
*
* // Define the index offset:
* var ox = 0;
*
* // Create an input ndarray:
* var x = new ndarray( 'generic', xbuf, sh, sx, ox, 'row-major' );
*
* // Create a from index ndarray:
* var fromIndex = scalar2ndarray( 0, {
*     'dtype': 'int32'
* });
*
* // Perform operation:
* var out = findIndex( x, fromIndex, isEven );
* // returns <ndarray>[ 1 ]
*/
var findIndex = factory( table, [ idtypes0, idtypes1 ], odtypes, policies );
 
 
// EXPORTS //
 
module.exports = findIndex;
 
// exports: { "assign": "findIndex.assign" }