Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 ### Features
 
+-   [`5149a37`](https://github.com/stdlib-js/stdlib/commit/5149a3789bf321b18b1636b838ab086175b6c2ca) - add `ndarray/base/unary-reduce-subarray-by` [(#7008)](https://github.com/stdlib-js/stdlib/pull/7008)
 -   [`54dc71e`](https://github.com/stdlib-js/stdlib/commit/54dc71e0ff4a2b5661d48a1bdee584507f66373f) - add `every` and `includes` to namespace
 -   [`2349a6e`](https://github.com/stdlib-js/stdlib/commit/2349a6edf849f8f7093a77bbdeb2fdd7d9955f89) - add `vector` to namespace
 -   [`1ab9f58`](https://github.com/stdlib-js/stdlib/commit/1ab9f58bcd109f19afd9ab08212d69bfe9d32bbe) - add `ndarray/vector` namespace
@@ -406,6 +407,7 @@ A total of 15 issues were closed in this release:
 
 <details>
 
+-   [`5149a37`](https://github.com/stdlib-js/stdlib/commit/5149a3789bf321b18b1636b838ab086175b6c2ca) - **feat:** add `ndarray/base/unary-reduce-subarray-by` [(#7008)](https://github.com/stdlib-js/stdlib/pull/7008) _(by Muhammad Haris, Athan Reines)_
 -   [`89d9dc3`](https://github.com/stdlib-js/stdlib/commit/89d9dc316985aa3c194222afbf8146e58ff6d761) - **docs:** update namespace table of contents [(#7046)](https://github.com/stdlib-js/stdlib/pull/7046) _(by stdlib-bot)_
 -   [`a300862`](https://github.com/stdlib-js/stdlib/commit/a300862d4f05d4d8bd85f1e235db93ad5d35a767) - **fix:** address increment bugs _(by Athan Reines)_
 -   [`fab9873`](https://github.com/stdlib-js/stdlib/commit/fab9873a907807195f2f6673b5b97f09e383bd69) - **fix:** address index bug _(by Athan Reines)_

CONTRIBUTORS

@@ -146,6 +146,7 @@ Ryan Seal <[email protected]>
 Rylan Yang <[email protected]>
 SAHIL KUMAR <[email protected]>
 SHIVAM YADAV <[email protected]>
+Sachin Raj <[email protected]>
 Sahil Goyal <[email protected]>
 Sai Avinash <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
@@ -170,6 +171,7 @@ Tanishq Ahuja <[email protected]>
 Tirtadwipa Manunggal <[email protected]>
 Tudor Pagu <[email protected]>
 Tufailahmed Bargir <[email protected]>
+Uday Kakade <[email protected]>
 Utkarsh <http://[email protected]>
 Utkarsh Raj <[email protected]>
 UtkershBasnet <[email protected]>

base/unary-reduce-subarray-by/README.md

@@ -0,0 +1,275 @@
+<!--
+
+@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.
+
+-->
+
+# unaryReduceSubarrayBy
+
+> Perform a reduction over a list of specified dimensions in an input ndarray according to a callback function and assign results to a provided output ndarray.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var unaryReduceSubarrayBy = require( '@stdlib/ndarray/base/unary-reduce-subarray-by' );
+```
+
+#### unaryReduceSubarrayBy( fcn, arrays, dims\[, options], clbk\[, thisArg] )
+
+Performs a reduction over a list of specified dimensions in an input ndarray according to a callback function and assigns results to a provided output ndarray.
+
+<!-- eslint-disable max-len -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+var filled = require( '@stdlib/array/base/filled' );
+var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
+var everyBy = require( '@stdlib/ndarray/base/every-by' );
+
+function clbk( value ) {
+    return value > 0.0;
+}
+
+// Create data buffers:
+var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 0.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+var ybuf = filled( false, 3 );
+
+// Define the array shapes:
+var xsh = [ 1, 3, 2, 2 ];
+var ysh = [ 1, 3 ];
+
+// Define the array strides:
+var sx = [ 12, 4, 2, 1 ];
+var sy = [ 3, 1 ];
+
+// Define the index offsets:
+var ox = 0;
+var oy = 0;
+
+// Create an input ndarray-like object:
+var x = {
+    'dtype': 'float64',
+    'data': xbuf,
+    'shape': xsh,
+    'strides': sx,
+    'offset': ox,
+    'order': 'row-major'
+};
+
+// Create an output ndarray-like object:
+var y = {
+    'dtype': 'generic',
+    'data': ybuf,
+    'shape': ysh,
+    'strides': sy,
+    'offset': oy,
+    'order': 'row-major'
+};
+
+// Perform a reduction:
+unaryReduceSubarrayBy( everyBy, [ x, y ], [ 2, 3 ], clbk );
+
+var arr = ndarray2array( y.data, y.shape, y.strides, y.offset, y.order );
+// returns [ [ true, false, true ] ]
+```
+
+The function accepts the following arguments:
+
+-   **fcn**: function which will be applied to a subarray and should reduce the subarray to a single scalar value.
+-   **arrays**: array-like object containing one input ndarray and one output ndarray, followed by any additional ndarray arguments.
+-   **dims**: list of dimensions over which to perform a reduction.
+-   **options**: function options which are passed through to `fcn` (_optional_).
+-   **clbk**: callback function.
+-   **thisArg**: callback 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 invoked callback function is provided the following arguments:
+
+-   **value**: input array element.
+-   **indices**: current array element indices.
+-   **arr**: the input ndarray.
+
+To set the callback execution context, provide a `thisArg`.
+
+<!-- eslint-disable max-len -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+var filled = require( '@stdlib/array/base/filled' );
+var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
+var everyBy = require( '@stdlib/ndarray/base/every-by' );
+
+function clbk( value ) {
+    this.count += 1;
+    return value > 0.0;
+}
+
+// Create data buffers:
+var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 0.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+var ybuf = filled( false, 6 );
+
+// Define the array shapes:
+var xsh = [ 3, 2, 2 ];
+var ysh = [ 3, 2 ];
+
+// Define the array strides:
+var sx = [ 4, 2, 1 ];
+var sy = [ 2, 1 ];
+
+// Define the index offsets:
+var ox = 0;
+var oy = 0;
+
+// Create an input ndarray-like object:
+var x = {
+    'dtype': 'float64',
+    'data': xbuf,
+    'shape': xsh,
+    'strides': sx,
+    'offset': ox,
+    'order': 'row-major'
+};
+
+// Create an output ndarray-like object:
+var y = {
+    'dtype': 'generic',
+    'data': ybuf,
+    'shape': ysh,
+    'strides': sy,
+    'offset': oy,
+    'order': 'row-major'
+};
+
+var ctx = {
+    'count': 0
+};
+
+// Perform a reduction:
+unaryReduceSubarrayBy( everyBy, [ x, y ], [ 1 ], clbk, ctx );
+
+var arr = ndarray2array( y.data, y.shape, y.strides, y.offset, y.order );
+// returns [ [ true, true ], [ true, false ], [ true, true ] ]
+
+var count = ctx.count;
+// returns 11
+```
+
+#### TODO: document factory method
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The output ndarray and any additional ndarray arguments are expected to have the same dimensions as the non-reduced dimensions of the input ndarray. When calling the reduction function, any additional ndarray arguments are provided as zero-dimensional ndarray-like objects.
+
+-   The reduction function is expected to have the following signature:
+
+    ```text
+    fcn( arrays[, options], wrappedCallback )
+    ```
+
+    where
+
+    -   **arrays**: array containing a subarray of the input ndarray and any additional ndarray arguments as zero-dimensional ndarrays.
+    -   **options**: function options (_optional_).
+    -   **wrappedCallback**: callback function. This function is a wrapper around a provided `clbk` argument.
+
+-   For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before performing a reduction 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 filled = require( '@stdlib/array/base/filled' );
+var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
+var everyBy = require( '@stdlib/ndarray/base/every-by' );
+var unaryReduceSubarrayBy = require( '@stdlib/ndarray/base/unary-reduce-subarray-by' );
+
+function clbk( value ) {
+    return value > -3;
+}
+
+var x = {
+    'dtype': 'generic',
+    'data': discreteUniform( 40, -5, 5, {
+        'dtype': 'generic'
+    }),
+    'shape': [ 2, 5, 2, 2 ],
+    'strides': [ 1, 2, 10, 20 ],
+    'offset': 0,
+    'order': 'column-major'
+};
+var y = {
+    'dtype': 'generic',
+    'data': filled( false, 10 ),
+    'shape': [ 2, 5 ],
+    'strides': [ 1, 2 ],
+    'offset': 0,
+    'order': 'column-major'
+};
+
+unaryReduceSubarrayBy( everyBy, [ x, y ], [ 2, 3 ], clbk );
+
+console.log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );
+console.log( ndarray2array( y.data, y.shape, y.strides, y.offset, y.order ) );
+```
+
+</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">
+
+</section>
+
+<!-- /.links -->