8000 feat: add `ndarray/base/unary-reduce-subarray-by` by headlessNode · Pull Request #7008 · stdlib-js/stdlib · GitHub
[go: up one dir, main page]
Skip to content

feat: add ndarray/base/unary-reduce-subarray-by #7008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
May 20, 2025
Merged

feat: add ndarray/base/unary-reduce-subarray-by #7008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a9d7121
feat: add unary-reduce-subarray-by
headlessNode May 15, 2025
55c698b
feat: add 4d kernels
headlessNode May 19, 2025
bc7d3d3
feat: add 5d kernels
headlessNode May 19, 2025
3d8ee07
feat: add 6d kernels
headlessNode May 19, 2025
f70cf28
feat: add 7d kernels
headlessNode May 20, 2025
268203e
fix: clbk indices
headlessNode May 20, 2025
60674e6
feat: add 8d kernels
headlessNode May 20, 2025
8000
ef84eb7
feat: add 9d kernels
headlessNode May 20, 2025
fe570fb
feat: add 10d kernels
headlessNode May 20, 2025
ac03c3f
fix: copy paste mistake
headlessNode May 20, 2025
084389b
chore: fix and clean-up
kgryte May 20, 2025
3f6c1d0
fix: missing offset incr
headlessNode May 20, 2025
3b993eb
Merge branch 'unary-red-sub-by' of https://github.com/headlessnode/st…
kgryte May 20, 2025
540bca7
docs: fix parameter name
kgryte May 20, 2025
6718027
refactor: remove nd-kernels from lists
kgryte May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
275 changes: 275 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/unary-reduce-subarray-by/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 -->
100 changes: 100 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/unary-reduce-subarray-by/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@

{{alias}}( 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.

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 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.

Parameters
----------
fcn: Function
Function which will be applied to a subarray and should reduce the
subarray to a single scalar value. The function should have the
following signature:

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.
- wrappedCallback: callback function. This function is a wrapper around
a provided `clbk` argument.

arrays: ArrayLikeObject<ndarray>
Array-like object containing one input ndarray and one output ndarray,
followed by any additional ndarray arguments.

dims: Array<integer>
List of dimensions over which to perform a reduction.

options: Object (optional)
Function options.

clbk: Function
Callback function.

thisArg: any (optional)
Callback execution context.

Examples
--------
// Define ndarray data and meta data...
> var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var ybuf = new {{alias:@stdlib/array/float64}}( [ 0.0 ] );
> var dtype = 'float64';
> var shx = [ 2, 2 ];
> var shy = [];
> var sx = [ 2, 1 ];
> var sy = [ 0 ];
> var ox = 0;
> var oy = 0;
> var order = 'row-major';

// Define a callback function:
> function clbk( value ) { return value; };

// Define a trivial reduction function...
> function fcn( arrays, clbk, thisArg ) {
... var v = arrays[0].data[ arrays[0].offset ];
... return clbk.call( thisArg, v, [ 0 ], arrays[0] );
... };

// Using minimal ndarray-like objects...
> x = {
... 'dtype': dtype,
... 'data': xbuf,
... 'shape': shx,
... 'strides': sx,
... 'offset': ox,
... 'order': order
... };
> y = {
... 'dtype': dtype,
... 'data': ybuf,
... 'shape': shy,
... 'strides': sy,
... 'offset': oy,
... 'order': order
... };
> {{alias}}( fcn, [ x, y ], [ 0, 1 ], clbk );
> y.data
<Float64Array>[ 1.0 ]

See Also
--------
Loading
0