feat: add blas/ext/find-index-between

lib/node_modules/@stdlib/blas/ext/find-index-between/README.md

@@ -0,0 +1,295 @@
+<!--
+
+@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.
+
+-->
+
+# findIndexBetween
+
+> Return the index of the first element along an [ndarray][@stdlib/ndarray/ctor] dimension which passes a test implemented by a predicate function within a specified range.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var findIndexBetween = require( '@stdlib/blas/ext/find-index-between' );
+```
+
+#### findIndexBetween( x, fromIndex, toIndex\[, options], clbk\[, thisArg] )
+
+Returns the index of the first element along an [ndarray][@stdlib/ndarray/ctor] dimension which passes a test implemented by a predicate function within a specified range.
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+function isEven( v ) {
+    return v % 2.0 === 0.0;
+}
+
+// Create an input ndarray:
+var x = array( [ 2.0, 1.0, 3.0, 4.0, 5.0, 6.0 ] );
+// returns <ndarray>
+
+// Perform operation:
+var out = findIndexBetween( x, 1, 4, isEven );
+// returns <ndarray>[ 3 ]
+```
+
+The function has the following parameters:
+
+-   **x**: input [ndarray][@stdlib/ndarray/ctor]. Must have at least one dimension.
+-   **fromIndex**: index from which to begin searching. May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having an integer index or "generic" [data type][@stdlib/ndarray/dtypes]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the non-reduced dimensions of the input [ndarray][@stdlib/ndarray/ctor]. For example, given the input shape `[2, 3, 4]` and `options.dim=0`, a provided [ndarray][@stdlib/ndarray/ctor] must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. If provided a negative integer, the index at which to begin searching along a dimension is determined by counting backward from the last element (where `-1` refers to the last element).
+-   **toIndex**: index at which to stop searching (exclusive). May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having an integer index or "generic" [data type][@stdlib/ndarray/dtypes]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the non-reduced dimensions of the input [ndarray][@stdlib/ndarray/ctor]. For example, given the input shape `[2, 3, 4]` and `options.dim=0`, a provided [ndarray][@stdlib/ndarray/ctor] must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. If provided a negative integer, the index at which to stop searching along a dimension is determined by counting backward from the last element (where `-1` refers to the last element).
+-   **options**: function options (_optional_).
+-   **clbk**: callback function.
+-   **thisArg**: callback execution context (_optional_).
+
+The invoked callback is provided three arguments:
+
+-   **value**: current array element.
+-   **idx**: current array element index.
+-   **array**: input ndarray.
+
+To set the callback execution context, provide a `thisArg`.
+
+<!-- eslint-disable no-invalid-this -->
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+function isEven( v ) {
+    this.count += 1;
+    return v % 2.0 === 0.0;
+}
+
+var x = array( [ 2.0, 1.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+var ctx = {
+    'count': 0
+};
+var out = findIndexBetween( x, 1, 4, isEven, ctx );
+// returns <ndarray>[ 3 ]
+
+var count = ctx.count;
+// returns 3
+```
+
+The function accepts the following options:
+
+-   **dtype**: output ndarray [data type][@stdlib/ndarray/dtypes]. Must be an integer index or generic [data type][@stdlib/ndarray/dtypes].
+-   **dim**: dimension over which to perform operation. If provided a negative integer, the dimension along which to perform the operation is determined by counting backward from the last dimension (where `-1` refers to the last dimension). Default: `-1`.
+-   **keepdims**: boolean indicating whether the reduced dimensions should be included in the returned [ndarray][@stdlib/ndarray/ctor] as singleton dimensions. Default: `false`.
+
+If no element along an [ndarray][@stdlib/ndarray/ctor] dimension passes a test implemented by the predicate function, the corresponding element in the returned [ndarray][@stdlib/ndarray/ctor] is `-1`.
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+function isEven( v ) {
+    return v % 2.0 === 0.0;
+}
+
+// Create an input ndarray:
+var x = array( [ 1.0, 3.0, 5.0, 7.0 ] );
+// returns <ndarray>
+
+// Perform operation:
+var out = findIndexBetween( x, 0, 4, isEven );
+// returns <ndarray>[ -1 ]
+```
+
+By default, the function performs the operation over elements in the last dimension. To perform the operation over a different dimension, provide a `dim` option.
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+function isEven( v ) {
+    return v % 2.0 === 0.0;
+}
+
+var x = array( [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] );
+
+var opts = {
+    'dim': 0
+};
+
+var out = findIndexBetween( x, 0, 2, opts, isEven );
+// returns <ndarray>[ -1, 0 ]
+```
+
+By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+function isEven( v ) {
+    return v % 2.0 === 0.0;
+}
+
+var x = array( [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] );
+
+var opts = {
+    'dim': 0,
+    'keepdims': true
+};
+
+var out = findIndexBetween( x, 0, 2, opts, isEven );
+// returns <ndarray>[ [ -1, 0 ] ]
+```
+
+By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option.
+
+```javascript
+var dtype = require( '@stdlib/ndarray/dtype' );
+var array = require( '@stdlib/ndarray/array' );
+
+function isEven( v ) {
+    return v % 2.0 === 0.0;
+}
+
+var x = array( [ 2.0, 1.0, 3.0, 4.0 ] );
+
+var opts = {
+    'dtype': 'generic'
+};
+
+var idx = findIndexBetween( x, 0, 4, opts, isEven );
+// returns <ndarray>[ 0 ]
+
+var dt = String( dtype( idx ) );
+// returns 'generic'
+```
+
+<!-- lint disable maximum-heading-length -->
+
+#### findIndexBetween.assign( x, fromIndex, toIndex, out\[, options], clbk\[, thisArg] )
+
+<!-- lint enable maximum-heading-length -->
+
+Returns the index of the first element along an [ndarray][@stdlib/ndarray/ctor] dimension which passes a test implemented by a predicate function within a specified range and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+
+function isEven( v ) {
+    return v % 2.0 === 0.0;
+}
+
+var x = array( [ 2.0, 1.0, 3.0, 4.0 ] );
+var y = zeros( [], {
+    'dtype': 'int32'
+});
+
+var out = findIndexBetween.assign( x, 0, 4, y, isEven );
+// returns <ndarray>[ 0 ]
+
+var bool = ( out === y );
+// returns true
+```
+
+The method has the following parameters:
+
+-   **x**: input [ndarray][@stdlib/ndarray/ctor]. Must have at least one dimension.
+-   **fromIndex**: index from which to begin searching. May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having an integer index or "generic" [data type][@stdlib/ndarray/dtypes]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the non-reduced dimensions of the input [ndarray][@stdlib/ndarray/ctor]. For example, given the input shape `[2, 3, 4]` and `options.dim=0`, a provided [ndarray][@stdlib/ndarray/ctor] must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. If provided a negative integer, the index at which to begin searching along a dimension is determined by counting backward from the last element (where `-1` refers to the last element).
+-   **toIndex**: index at which to stop searching (exclusive). May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having an integer index or "generic" [data type][@stdlib/ndarray/dtypes]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the non-reduced dimensions of the input [ndarray][@stdlib/ndarray/ctor]. For example, given the input shape `[2, 3, 4]` and `options.dim=0`, a provided [ndarray][@stdlib/ndarray/ctor] must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. If provided a negative integer, the index at which to stop searching along a dimension is determined by counting backward from the last element (where `-1` refers to the last element).
+-   **out**: output [ndarray][@stdlib/ndarray/ctor].
+-   **options**: function options (_optional_).
+-   **clbk**: callback function.
+-   **thisArg**: callback execution context (_optional_).
+
+The method accepts the following options:
+
+-   **dim**: dimension over which to perform operation. If provided a negative integer, the dimension along which to perform the operation is determined by counting backward from the last dimension (where `-1` refers to the last dimension). Default: `-1`.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   A provided callback function should return a boolean.
+-   Setting the `keepdims` option to `true` can be useful when wanting to ensure that the output [ndarray][@stdlib/ndarray/ctor] is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with ndarrays having the same shape as the input [ndarray][@stdlib/ndarray/ctor].
+-   The output data type [policy][@stdlib/ndarray/output-dtype-policies] only applies to the main function and specifies that, by default, the function must return an [ndarray][@stdlib/ndarray/ctor] having an integer index or "generic" [data type][@stdlib/ndarray/dtypes]. For the `assign` method, the output [ndarray][@stdlib/ndarray/ctor] is allowed to have any supported output [data type][@stdlib/ndarray/dtypes].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var findIndexBetween = require( '@stdlib/blas/ext/find-index-between' );
+
+// Define a callback function:
+function isEven( v ) {
+    return v % 2.0 === 0.0;
+}
+
+// Generate an ndarray of random numbers:
+var x = discreteUniform( [ 5, 2 ], 0, 20, {
+    'dtype': 'generic'
+});
+console.log( ndarray2array( x ) );
+
+var opts = {
+    'dim': 0
+};
+
+// Perform operation:
+var idx = findIndexBetween( x, 0, 5, opts, isEven );
+
+// Print the results:
+console.log( ndarray2array( idx ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
+
+[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
+
+[@stdlib/ndarray/output-dtype-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/output-dtype-policies
+
+[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
+
+</section>
+
+<!-- /.links -->