Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Dec 13, 2024
1 parent 76d7987 commit cd24ce0
Show file tree
Hide file tree
Showing 11 changed files with 1,481 additions and 2 deletions.
39 changes: 37 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,40 @@ This release closes the following issue:

<!-- /.package -->

<section class="package" id="array-base-broadcasted-quaternary5d-unreleased">

#### [@stdlib/array/base/broadcasted-quaternary5d](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/broadcasted-quaternary5d)

<details>

<section class="features">

##### Features

- [`f71dbdc`](https://github.com/stdlib-js/stdlib/commit/f71dbdc7ea992486cdc2042c24a6d4a2b57c002e) - add `array/base/broadcasted/quaternary5d` [(#3301)](https://github.com/stdlib-js/stdlib/pull/3301)

</section>

<!-- /.features -->

<section class="issues">

##### Closed Issues

This release closes the following issue:

[#3169](https://github.com/stdlib-js/stdlib/issues/3169)

</section>

<!-- /.issues -->

</details>

</section>

<!-- /.package -->

<section class="package" id="array-base-broadcasted-ternary3d-unreleased">

#### [@stdlib/array/base/broadcasted-ternary3d](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/broadcasted-ternary3d)
Expand Down Expand Up @@ -763,9 +797,9 @@ A total of 12 issues were closed in this release:

### Closed Issues

A total of 25 issues were closed in this release:
A total of 26 issues were closed in this release:

[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3140](https://github.com/stdlib-js/stdlib/issues/3140), [#3145](https://github.com/stdlib-js/stdlib/issues/3145), [#3146](https://github.com/stdlib-js/stdlib/issues/3146), [#3147](https://github.com/stdlib-js/stdlib/issues/3147), [#3149](https://github.com/stdlib-js/stdlib/issues/3149), [#3150](https://github.com/stdlib-js/stdlib/issues/3150), [#3151](https://github.com/stdlib-js/stdlib/issues/3151), [#3152](https://github.com/stdlib-js/stdlib/issues/3152), [#3155](https://github.com/stdlib-js/stdlib/issues/3155), [#3162](https://github.com/stdlib-js/stdlib/issues/3162), [#3164](https://github.com/stdlib-js/stdlib/issues/3164), [#3165](https://github.com/stdlib-js/stdlib/issues/3165), [#3166](https://github.com/stdlib-js/stdlib/issues/3166), [#3167](https://github.com/stdlib-js/stdlib/issues/3167), [#3168](https://github.com/stdlib-js/stdlib/issues/3168), [#3173](https://github.com/stdlib-js/stdlib/issues/3173), [#3174](https://github.com/stdlib-js/stdlib/issues/3174), [#3175](https://github.com/stdlib-js/stdlib/issues/3175), [#3176](https://github.com/stdlib-js/stdlib/issues/3176), [#3177](https://github.com/stdlib-js/stdlib/issues/3177), [#3178](https://github.com/stdlib-js/stdlib/issues/3178), [#3179](https://github.com/stdlib-js/stdlib/issues/3179), [#3180](https://github.com/stdlib-js/stdlib/issues/3180)
[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3140](https://github.com/stdlib-js/stdlib/issues/3140), [#3145](https://github.com/stdlib-js/stdlib/issues/3145), [#3146](https://github.com/stdlib-js/stdlib/issues/3146), [#3147](https://github.com/stdlib-js/stdlib/issues/3147), [#3149](https://github.com/stdlib-js/stdlib/issues/3149), [#3150](https://github.com/stdlib-js/stdlib/issues/3150), [#3151](https://github.com/stdlib-js/stdlib/issues/3151), [#3152](https://github.com/stdlib-js/stdlib/issues/3152), [#3155](https://github.com/stdlib-js/stdlib/issues/3155), [#3162](https://github.com/stdlib-js/stdlib/issues/3162), [#3164](https://github.com/stdlib-js/stdlib/issues/3164), [#3165](https://github.com/stdlib-js/stdlib/issues/3165), [#3166](https://github.com/stdlib-js/stdlib/issues/3166), [#3167](https://github.com/stdlib-js/stdlib/issues/3167), [#3168](https://github.com/stdlib-js/stdlib/issues/3168), [#3169](https://github.com/stdlib-js/stdlib/issues/3169), [#3173](https://github.com/stdlib-js/stdlib/issues/3173), [#3174](https://github.com/stdlib-js/stdlib/issues/3174), [#3175](https://github.com/stdlib-js/stdlib/issues/3175), [#3176](https://github.com/stdlib-js/stdlib/issues/3176), [#3177](https://github.com/stdlib-js/stdlib/issues/3177), [#3178](https://github.com/stdlib-js/stdlib/issues/3178), [#3179](https://github.com/stdlib-js/stdlib/issues/3179), [#3180](https://github.com/stdlib-js/stdlib/issues/3180)

</section>

Expand Down Expand Up @@ -800,6 +834,7 @@ A total of 12 people contributed to this release. Thank you to the following con

<details>

- [`f71dbdc`](https://github.com/stdlib-js/stdlib/commit/f71dbdc7ea992486cdc2042c24a6d4a2b57c002e) - **feat:** add `array/base/broadcasted/quaternary5d` [(#3301)](https://github.com/stdlib-js/stdlib/pull/3301) _(by Gururaj Gurram, Athan Reines, stdlib-bot)_
- [`263de1a`](https://github.com/stdlib-js/stdlib/commit/263de1acfc9faf6b355b54d4dbdc0048b1288fab) - **docs:** fix example _(by Athan Reines)_
- [`5cb36ef`](https://github.com/stdlib-js/stdlib/commit/5cb36ef4c6f8158585ac88867a8dec21ed3fa372) - **docs:** update related packages sections [(#3890)](https://github.com/stdlib-js/stdlib/pull/3890) _(by stdlib-bot)_
- [`f9466a9`](https://github.com/stdlib-js/stdlib/commit/f9466a9409c3c4f76ac36c7393787916316b0f7e) - **feat:** add `array/base/broadcasted-quaternary4d` [(#3257)](https://github.com/stdlib-js/stdlib/pull/3257) _(by Gururaj Gurram, Athan Reines, stdlib-bot)_
Expand Down
147 changes: 147 additions & 0 deletions base/broadcasted-quaternary5d/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
<!--
@license Apache-2.0
Copyright (c) 2024 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.
-->

# bquaternary5d

> Apply a quaternary callback to elements in four [broadcasted][@stdlib/array/base/broadcast-array] input arrays and assign results to elements in a five-dimensional nested output array.
<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var bquaternary5d = require( '@stdlib/array/base/broadcasted-quaternary5d' );
```

#### bquaternary5d( arrays, shapes, fcn )

Applies a quaternary callback to elements in four [broadcasted][@stdlib/array/base/broadcast-array] input arrays and assigns results to elements in a five-dimensional nested output array.

```javascript
var add = require( '@stdlib/math/base/ops/add4' );
var zeros5d = require( '@stdlib/array/base/zeros5d' );

var x = [ [ 1.0, 2.0 ] ];
var y = [ [ 3.0 ], [ 4.0 ] ];
var z = [ [ 5.0 ] ];
var w = [ [ 2.0 ] ];
var out = zeros5d( [ 1, 1, 2, 2, 2 ] );

var shapes = [
[ 1, 2 ],
[ 2, 1 ],
[ 1, 1 ],
[ 1, 1 ],
[ 1, 1, 2, 2, 2 ]
];

bquaternary5d( [ x, y, z, w, out ], shapes, add );
// out => [ [ [ [ [ 11.0, 12.0 ], [ 12.0, 13.0 ] ], [ [ 11.0, 12.0 ], [ 12.0, 13.0 ] ] ] ] ]
```

The function accepts the following arguments:

- **arrays**: array-like object containing four input nested arrays and one output nested array.
- **shapes**: array shapes.
- **fcn**: quaternary function to apply.

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- The input and output array shapes must be broadcast [compatible][@stdlib/ndarray/base/broadcast-shapes].

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filled5dBy = require( '@stdlib/array/base/filled5d-by' );
var zeros5d = require( '@stdlib/array/base/zeros5d' );
var add = require( '@stdlib/math/base/ops/add4' );
var bquaternary5d = require( '@stdlib/array/base/broadcasted-quaternary5d' );

var shapes = [
[ 1, 1, 1, 3, 1 ],
[ 1, 3, 1, 1, 1 ],
[ 1, 1, 1, 1, 3 ],
[ 1, 1, 3, 1, 1 ],
[ 1, 3, 3, 3, 3 ]
];

var x = filled5dBy( shapes[ 0 ], discreteUniform( -100, 100 ) );
console.log( x );

var y = filled5dBy( shapes[ 1 ], discreteUniform( -100, 100 ) );
console.log( y );

var z = filled5dBy( shapes[ 2 ], discreteUniform( -100, 100 ) );
console.log( z );

var w = filled5dBy( shapes[ 3 ], discreteUniform( -100, 100 ) );
console.log( w );

var out = zeros5d( shapes[ 4 ] );
console.log( z );

bquaternary5d( [ x, y, z, w, out ], shapes, add );
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 for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[@stdlib/array/base/broadcast-array]: https://github.com/stdlib-js/array/tree/main/base/broadcast-array

[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes

</section>

<!-- /.links -->
139 changes: 139 additions & 0 deletions base/broadcasted-quaternary5d/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2024 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 bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var floor = require( '@stdlib/math/base/special/floor' );
var add = require( '@stdlib/math/base/ops/add4' );
var filled5dBy = require( './../../../base/filled5d-by' );
var zeros5d = require( './../../../base/zeros5d' );
var numel = require( '@stdlib/ndarray/base/numel' );
var pkg = require( './../package.json' ).name;
var bquaternary5d = require( './../lib' );


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveIntegerArray} shape - output array shape
* @returns {Function} benchmark function
*/
function createBenchmark( shape ) {
var arrays;
var shapes;
var out;
var x;
var y;
var z;
var w;

shapes = [
[ 1, 1, 1, 1, shape[ 2 ] ],
[ 1, 1, 1, shape[ 1 ], 1 ],
[ 1, 1, shape[ 0 ], 1, 1 ],
[ 1, 1, shape[ 0 ], shape[ 1 ], shape[ 2 ] ],
shape
];
x = filled5dBy( shapes[ 0 ], uniform( -100.0, 100.0 ) );
y = filled5dBy( shapes[ 1 ], uniform( -100.0, 100.0 ) );
z = filled5dBy( shapes[ 2 ], uniform( -100.0, 100.0 ) );
w = filled5dBy( shapes[ 3 ], uniform( -100.0, 100.0 ) );
out = zeros5d( shapes[ 4 ] );

arrays = [ x, y, z, w, out ];

return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var i0;
var i1;
var i2;
var i3;
var i4;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
bquaternary5d( arrays, shapes, add );
i4 = i % shapes[ 1 ][ 0 ];
i3 = i % shapes[ 1 ][ 1 ];
i2 = i % shapes[ 1 ][ 2 ];
i1 = i % shapes[ 1 ][ 3 ];
i0 = i % shapes[ 1 ][ 4 ];
if ( isnan( arrays[ 4 ][ i4 ][ i3 ][ i2 ][ i1 ][ i0 ] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();

i4 = i % shapes[ 1 ][ 0 ];
i3 = i % shapes[ 1 ][ 1 ];
i2 = i % shapes[ 1 ][ 2 ];
i1 = i % shapes[ 1 ][ 3 ];
i0 = i % shapes[ 1 ][ 4 ];
if ( isnan( arrays[ 4 ][ i4 ][ i3 ][ i2 ][ i1 ][ i0 ] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var min;
var max;
var sh;
var N;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max

for ( i = min; i <= max; i++ ) {
N = floor( pow( pow( 10, i ), 1.0/5.0 ) );
sh = [ N, N, N, N, N ];
f = createBenchmark( sh );
bench( pkg+'::equidimensional:size='+numel( sh ), f );
}
}

main();
32 changes: 32 additions & 0 deletions base/broadcasted-quaternary5d/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

{{alias}}( arrays, shapes, fcn )
Applies a quaternary callback to elements in four broadcasted input arrays
and assigns results to elements in a five-dimensional nested output array.

Parameters
----------
arrays: ArrayLikeObject
Array-like object containing four input nested arrays and one output
nested array.

shapes: Array<Array<integer>>
Array shapes.

fcn: Function
Quaternary callback.

Examples
--------
> function fcn( x, y, z, w ) { return x + y + z + w; };
> var x = [ 1.0, 2.0 ];
> var y = [ [ 3.0 ], [ 4.0 ] ];
> var z = [ [ 5.0 ] ];
> var w = [ 1.0 ];
> var out = [ [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ] ];
> var shapes = [ [ 2 ], [ 2, 1 ], [ 1, 1 ], [ 1 ], [ 1, 1, 1, 2, 2 ] ];
> {{alias}}( [ x, y, z, w, out ], shapes, fcn );
> out
[ [ [ [ [ 10.0, 11.0 ], [ 11.0, 12.0 ] ] ] ] ]

See Also
--------
Loading

0 comments on commit cd24ce0

Please sign in to comment.