feat: add array/base/broadcasted-quinary3d

lib/node_modules/@stdlib/array/base/broadcasted-quinary3d/README.md

@@ -0,0 +1,159 @@
+<!--
+
+@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.
+
+-->
+
+# bquinary3d
+
+> Apply a quinary callback to elements in four [broadcasted][@stdlib/array/base/broadcast-array] nested input arrays and assign results to elements in a three-dimensional nested output array.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var bquinary3d = require( '@stdlib/array/base/broadcasted-quinary3d' );
+```
+
+#### bquinary3d( arrays, shapes, fcn )
+
+Applies a quinary callback to elements in four [broadcasted][@stdlib/array/base/broadcast-array] nested input arrays and assigns results to elements in a three-dimensional nested output array.
+
+```javascript
+var zeros3d = require( '@stdlib/array/base/zeros3d' );
+
+function add( x, y, z, w, v ) {
+    return x + y + z + w + v;
+}
+
+var x = [ [ [ 1.0, 2.0 ] ] ];
+var y = [ [ [ 3.0 ], [ 4.0 ] ] ];
+var z = [ [ [ 5.0 ] ] ];
+var w = [ [ [ 2.0 ] ] ];
+var v = [ [ [ 1.0 ] ] ];
+var out = zeros3d( [ 2, 2, 2 ] );
+
+var shapes = [
+    [ 1, 2, 1 ],
+    [ 2, 1, 1 ],
+    [ 1, 1, 1 ],
+    [ 2, 2, 1 ],
+    [ 1, 1, 2 ],
+    [ 2, 2, 2 ]
+];
+
+bquinary3d( [ x, y, z, w, v, out ], shapes, add );
+// out => [ [ [ 12.0, 13.0 ], [ 13.0, 14.0 ] ] 3
+```
+
+The function accepts the following arguments:
+
+-   **arrays**: array-like object containing five input nested arrays and one output nested array.
+-   **shapes**: array shapes.
+-   **fcn**: quinary 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 filled3dBy = require( '@stdlib/array/base/filled3d-by' );
+var zeros3d = require( '@stdlib/array/base/zeros3d' );
+var bquinary3d = require( '@stdlib/array/base/broadcasted-quinary3d' );
+
+function add( x, y, z, w, v ) {
+    return x + y + z + w + v;
+}
+
+var shapes = [
+    [ 1, 3, 1 ],
+    [ 3, 1, 1 ],
+    [ 1, 1, 3 ],
+    [ 3, 3, 1 ],
+    [ 1, 3, 3 ],
+    [ 3, 3, 3 ]
+];
+
+var x = filled3dBy( shapes[ 0 ], discreteUniform( -100, 100 ) );
+console.log( x );
+
+var y = filled3dBy( shapes[ 1 ], discreteUniform( -100, 100 ) );
+console.log( y );
+
+var z = filled3dBy( shapes[ 2 ], discreteUniform( -100, 100 ) );
+console.log( z );
+
+var w = filled3dBy( shapes[ 3 ], discreteUniform( -100, 100 ) );
+console.log( w );
+
+var v = filled3dBy( shapes[ 4 ], discreteUniform( -100, 100 ) );
+console.log( v );
+
+var out = zeros3d( shapes[ 5 ] );
+console.log( out );
+
+bquinary3d( [ x, y, z, w, v, 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/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/broadcast-array
+
+[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/array/base/broadcasted-quinary3d/benchmark/benchmark.js

@@ -0,0 +1,150 @@
+/**
+* @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 filled3dBy = require( '@stdlib/array/base/filled3d-by' );
+var zeros3d = require( '@stdlib/array/base/zeros3d' );
+var numel = require( '@stdlib/ndarray/base/numel' );
+var pkg = require( './../package.json' ).name;
+var bquinary3d = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Returns the sum.
+*
+* @private
+* @param {number} x - first value
+* @param {number} y - second value
+* @param {number} z - third value
+* @param {number} w - fourth value
+* @param {number} v - fifth value
+* @returns {number} sum
+*/
+function add( x, y, z, w, v ) {
+	return x + y + z + w + v;
+}
+
+/**
+* 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;
+	var v;
+
+	shapes = [
+		[ 1, 1, shape[ 2 ] ],
+		[ 1, shape[ 1 ], 1 ],
+		[ 1, 1, shape[ 0 ] ],
+		[ 1, 1, 1 ],
+		[ shape[ 0 ], shape[ 1 ], shape[ 2 ] ],
+		shape
+	];
+	x = filled3dBy( shapes[ 0 ], uniform( -100.0, 100.0 ) );
+	y = filled3dBy( shapes[ 1 ], uniform( -100.0, 100.0 ) );
+	z = filled3dBy( shapes[ 2 ], uniform( -100.0, 100.0 ) );
+	w = filled3dBy( shapes[ 3 ], uniform( -100.0, 100.0 ) );
+	v = filled3dBy( shapes[ 4 ], uniform( -100.0, 100.0 ) );
+	out = zeros3d( shapes[ 5 ] );
+
+	arrays = [ x, y, z, w, v, out ];
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var i0;
+		var i1;
+		var i2;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			bquinary3d( arrays, shapes, add );
+			i2 = i % shapes[ 1 ][ 0 ];
+			i1 = i % shapes[ 1 ][ 1 ];
+			i0 = i % shapes[ 1 ][ 2 ];
+			if ( isnan( arrays[ 5 ][ i2 ][ i1 ][ i0 ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+
+		i2 = i % shapes[ 1 ][ 0 ];
+		i1 = i % shapes[ 1 ][ 1 ];
+		i0 = i % shapes[ 1 ][ 2 ];
+		if ( isnan( arrays[ 5 ][ 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/3.0 ) );
+		sh = [ N, N, N ];
+		f = createBenchmark( sh );
+		bench( pkg+'::square_matrix:size='+numel( sh ), f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/array/base/broadcasted-quinary3d/docs/repl.txt

@@ -0,0 +1,32 @@
+{{alias}}( arrays, shapes, fcn )
+    Applies a quinary callback to elements in five broadcasted input arrays
+    and assigns results to elements in a three-dimensional nested output array.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject
+        Array-like object containing five input nested arrays and one output
+        nested array.
+
+    shapes: Array<Array<integer>>
+        Array shapes.
+
+    fcn: Function
+        Quinary callback.
+
+    Examples
+    --------
+    > function fcn( x, y, z, w, v ) { return x + y + z + w + v; };
+    > var x = [ 1.0, 2.0 ];
+    > var y = [ [ [ 3.0 ], [ 4.0 ] ] ];
+    > var z = [ [ [ 1.0 ] ] ];
+    > var w = [ 2.0 ];
+    > var v = [ 1.0 ];
+    > var out = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ];
+    > var shapes = [ [ 2 ], [ 2, 1, 1 ] [ 1, 2, 2 ], [ 1, 1, 2 ], [ 1 ], [ 1, 2, 1 ], [ 2, 2, 2 ] ];
+    > {{alias}}( [ x, y, z, w, v, out ], shapes, fcn );
+    > out
+    [ [ [ 8.0, 9.0 ], [ 9.0, 10.0 ] ] ]
+
+    See Also
+    --------