All files / base/ndarray/gfind-index-between/lib main.js

62.5% Statements 75/120
100% Branches 1/1
0% Functions 0/1
62.5% Lines 75/120

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 1211x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                                                                           1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' );
var getStride = require( '@stdlib/ndarray/base/stride' );
var getOffset = require( '@stdlib/ndarray/base/offset' );
var getData = require( '@stdlib/ndarray/base/data-buffer' );
var clipIndex = require( '@stdlib/ndarray/base/clip-index' );
var strided = require( '@stdlib/blas/ext/base/gfind-index' ).ndarray;
 
 
// MAIN //
 
/**
* Returns the index of the first element in a one-dimensional ndarray which passes a test implemented by a predicate function within a specified range.
*
* ## Notes
*
* -   The function expects the following ndarrays:
*
*     -   a one-dimensional input ndarray.
*     -   a zero-dimensional ndarray containing the index from which to begin searching.
*     -   a zero-dimensional ndarray containing the index at which to stop searching (exclusive).
*
* @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
* @param {Function} clbk - callback function
* @param {*} [thisArg] - callback execution context
* @returns {integer} index
*
* @example
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var vector = require( '@stdlib/ndarray/vector/ctor' );
*
* function clbk( v ) {
*     return v % 2.0 === 0.0;
* }
*
* var x = vector( [ 2.0, 1.0, 3.0, 4.0, 5.0 ], 'generic' );
*
* var fromIndex = scalar2ndarray( 1, {
*     'dtype': 'generic'
* });
*
* var toIndex = scalar2ndarray( 4, {
*     'dtype': 'generic'
* });
*
* var v = gfindIndexBetween( [ x, fromIndex, toIndex ], clbk );
* // returns 3
*/
function gfindIndexBetween( arrays, clbk, thisArg ) {
	var fromIndex;
	var toIndex;
	var stride;
	var offset;
	var idx;
	var N;
	var n;
	var x;

	x = arrays[ 0 ];
	fromIndex = ndarraylike2scalar( arrays[ 1 ] );
	toIndex = ndarraylike2scalar( arrays[ 2 ] );

	N = numelDimension( x, 0 );
	fromIndex = clipIndex( fromIndex, N );
	toIndex = clipIndex( toIndex, N );

	n = toIndex - fromIndex;
	if ( n <= 0 ) {
		return -1;
	}
	stride = getStride( x, 0 );
	offset = getOffset( x ) + ( stride*fromIndex );

	idx = strided( n, getData( x ), stride, offset, wrapper, null );
	if ( idx >= 0 ) {
		idx += fromIndex;
	}
	return idx;

	/**
	* Invokes a provided callback.
	*
	* @private
	* @param {*} value - current array element
	* @param {NonNegativeInteger} aidx - current array element index
	* @param {NonNegativeInteger} sidx - current strided array element index
	* @param {Collection} arr - input array
	* @returns {*} result
	*/
	function wrapper( value, aidx ) {
		return clbk.call( thisArg, value, aidx + fromIndex, x );
	}
}
 
 
// EXPORTS //
 
module.exports = gfindIndexBetween;