Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 ### Features
 
+-   [`50b84b5`](https://github.com/stdlib-js/stdlib/commit/50b84b54ffdfc65c9c92498f51120ef3a363a69e) - add `ndarray/base/find` [(#7426)](https://github.com/stdlib-js/stdlib/pull/7426)
 -   [`b7b141b`](https://github.com/stdlib-js/stdlib/commit/b7b141b93a4d030ce23c6ebe50264bd910e5fdf2) - add `ndarray/base/any-by` [(#7664)](https://github.com/stdlib-js/stdlib/pull/7664)
 -   [`8e8e3a4`](https://github.com/stdlib-js/stdlib/commit/8e8e3a410a266afa887a1c9f9df7f98833bfa4ea) - add `ndarray/with` [(#7971)](https://github.com/stdlib-js/stdlib/pull/7971)
 -   [`f043c89`](https://github.com/stdlib-js/stdlib/commit/f043c893ac0fe9392f7b764167899a482d84708e) - add `ndarray/base/nullary-strided1d` [(#7772)](https://github.com/stdlib-js/stdlib/pull/7772)
@@ -500,6 +501,7 @@ A total of 24 issues were closed in this release:
 
 <details>
 
+-   [`50b84b5`](https://github.com/stdlib-js/stdlib/commit/50b84b54ffdfc65c9c92498f51120ef3a363a69e) - **feat:** add `ndarray/base/find` [(#7426)](https://github.com/stdlib-js/stdlib/pull/7426) _(by Muhammad Haris, Athan Reines)_
 -   [`9be4cfa`](https://github.com/stdlib-js/stdlib/commit/9be4cfa08c56d4d736bece90bb713d339db3d9cc) - **docs:** update range to match the one used in example file _(by Philipp Burckhardt)_
 -   [`b7b141b`](https://github.com/stdlib-js/stdlib/commit/b7b141b93a4d030ce23c6ebe50264bd910e5fdf2) - **feat:** add `ndarray/base/any-by` [(#7664)](https://github.com/stdlib-js/stdlib/pull/7664) _(by Muhammad Haris, Athan Reines)_
 -   [`8e8e3a4`](https://github.com/stdlib-js/stdlib/commit/8e8e3a410a266afa887a1c9f9df7f98833bfa4ea) - **feat:** add `ndarray/with` [(#7971)](https://github.com/stdlib-js/stdlib/pull/7971) _(by Muhammad Haris, Athan Reines)_

base/find/README.md

@@ -0,0 +1,246 @@
+<!--
+
+@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.
+
+-->
+
+# find
+
+> Return the first element in an ndarray which passes a test implemented by a predicate function.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+<!-- eslint-disable no-redeclare -->
+
+```javascript
+var find = require( '@stdlib/ndarray/base/find' );
+```
+
+<!-- eslint-enable no-redeclare -->
+
+#### find( arrays, predicate\[, thisArg] )
+
+Returns the first element in an ndarray which passes a test implemented by a predicate function.
+
+<!-- eslint-disable max-len -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+function isEven( value ) {
+    return value % 2.0 === 0.0;
+}
+
+// Create a data buffer:
+var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+
+// Define the shape of the input array:
+var shape = [ 3, 1, 2 ];
+
+// Define the array strides:
+var sx = [ 4, 4, 1 ];
+
+// Define the index offset:
+var ox = 0;
+
+// Create the input ndarray-like object:
+var x = {
+    'dtype': 'float64',
+    'data': xbuf,
+    'shape': shape,
+    'strides': sx,
+    'offset': ox,
+    'order': 'row-major'
+};
+
+// Create an ndarray-like object containing a sentinel value:
+var sentinelValue = {
+    'dtype': 'float64',
+    'data': new Float64Array( [ NaN ] ),
+    'shape': [],
+    'strides': [ 0 ],
+    'offset': 0,
+    'order': 'row-major'
+};
+
+// Perform reduction:
+var out = find( [ x, sentinelValue ], isEven );
+// returns 2.0
+```
+
+The function accepts the following arguments:
+
+-   **arrays**: array-like object containing an input ndarray and a zero-dimensional ndarray containing a sentinel value. The sentinel value is returned when no element in an input ndarray passes a test implemented by the predicate function.
+-   **predicate**: predicate function.
+-   **thisArg**: predicate function execution context (_optional_).
+
+Each provided ndarray should be an object with the following properties:
+
+-   **dtype**: data type.
+-   **data**: data buffer.
+-   **shape**: dimensions.
+-   **strides**: stride lengths.
+-   **offset**: index offset.
+-   **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
+
+The predicate function is provided the following arguments:
+
+-   **value**: current array element.
+-   **indices**: current array element indices.
+-   **arr**: the input ndarray.
+
+To set the predicate function execution context, provide a `thisArg`.
+
+<!-- eslint-disable no-invalid-this, max-len -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+function isEven( value ) {
+    this.count += 1;
+    return value % 2.0 === 0.0;
+}
+
+// Create a data buffer:
+var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+
+// Define the shape of the input array:
+var shape = [ 3, 1, 2 ];
+
+// Define the array strides:
+var sx = [ 4, 4, 1 ];
+
+// Define the index offset:
+var ox = 0;
+
+// Create the input ndarray-like object:
+var x = {
+    'dtype': 'float64',
+    'data': xbuf,
+    'shape': shape,
+    'strides': sx,
+    'offset': ox,
+    'order': 'row-major'
+};
+
+// Create an ndarray-like object containing a sentinel value:
+var sentinelValue = {
+    'dtype': 'float64',
+    'data': new Float64Array( [ NaN ] ),
+    'shape': [],
+    'strides': [ 0 ],
+    'offset': 0,
+    'order': 'row-major'
+};
+
+var ctx = {
+    'count': 0
+};
+
+// Perform reduction:
+var out = find( [ x, sentinelValue ], isEven, ctx );
+// returns 2.0
+
+var count = ctx.count;
+// returns 2
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before performing the operation in order to achieve better performance.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var Float64Array = require( '@stdlib/array/float64' );
+var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
+var find = require( '@stdlib/ndarray/base/find' );
+
+function isEven( value ) {
+    return value % 2.0 === 0.0;
+}
+
+var x = {
+    'dtype': 'float64',
+    'data': discreteUniform( 10, 0.0, 10.0, {
+        'dtype': 'float64'
+    }),
+    'shape': [ 5, 2 ],
+    'strides': [ 2, 1 ],
+    'offset': 0,
+    'order': 'row-major'
+};
+console.log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );
+
+var sv = {
+    'dtype': 'float64',
+    'data': new Float64Array( [ NaN ] ),
+    'shape': [],
+    'strides': [ 0 ],
+    'offset': 0,
+    'order': x.order
+};
+console.log( 'Sentinel Value: %d', sv.data[ 0 ] );
+
+var out = find( [ x, sv ], isEven );
+console.log( out );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<section class="links">
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->