Auto-generated commit

base/lib/index.js

@@ -648,6 +648,15 @@ setReadOnly( ns, 'quaternary2d', require( './../../base/quaternary2d' ) );
 */
 setReadOnly( ns, 'quaternary3d', require( './../../base/quaternary3d' ) );
 
+/**
+* @name quaternary4d
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/array/base/quaternary4d}
+*/
+setReadOnly( ns, 'quaternary4d', require( './../../base/quaternary4d' ) );
+
 /**
 * @name quinary2d
 * @memberof ns

base/quaternary3d/docs/types/test.ts

@@ -42,19 +42,19 @@ function fcn( x: number, y: number, z: number, w: number ): number {
 	const w = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ];
 	const out = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ];
 
-	quaternary3d( [ x, y, z, w, out ], [ 2, 2, 2 ], fcn ); // $ExpectType void
+	quaternary3d( [ x, y, z, w, out ], [ 1, 2, 2 ], fcn ); // $ExpectType void
 }
 
 // The compiler throws an error if the function is provided a first argument which is not an array of nested arrays...
 {
-	quaternary3d( 'abc', [ 2, 2, 2 ], fcn ); // $ExpectError
-	quaternary3d( 3.14, [ 2, 2, 2 ], fcn ); // $ExpectError
-	quaternary3d( true, [ 2, 2, 2 ], fcn ); // $ExpectError
-	quaternary3d( false, [ 2, 2, 2 ], fcn ); // $ExpectError
-	quaternary3d( null, [ 2, 2, 2 ], fcn ); // $ExpectError
-	quaternary3d( [ '1' ], [ 2, 2, 2 ], fcn ); // $ExpectError
-	quaternary3d( {}, [ 2, 2, 2 ], fcn ); // $ExpectError
-	quaternary3d( ( x: number ): number => x, [ 2, 2, 2 ], fcn ); // $ExpectError
+	quaternary3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError
+	quaternary3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError
+	quaternary3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError
+	quaternary3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError
+	quaternary3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError
+	quaternary3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError
+	quaternary3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError
+	quaternary3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided a second argument which is not an array of numbers...
@@ -83,13 +83,13 @@ function fcn( x: number, y: number, z: number, w: number ): number {
 	const w = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ];
 	const out = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ];
 
-	quaternary3d( [ x, y, z, w, out ], [ 2, 2, 2 ], 'abc' ); // $ExpectError
-	quaternary3d( [ x, y, z, w, out ], [ 2, 2, 2 ], 3.14 ); // $ExpectError
-	quaternary3d( [ x, y, z, w, out ], [ 2, 2, 2 ], true ); // $ExpectError
-	quaternary3d( [ x, y, z, w, out ], [ 2, 2, 2 ], false ); // $ExpectError
-	quaternary3d( [ x, y, z, w, out ], [ 2, 2, 2 ], null ); // $ExpectError
-	quaternary3d( [ x, y, z, w, out ], [ 2, 2, 2 ], [ '1' ] ); // $ExpectError
-	quaternary3d( [ x, y, z, w, out ], [ 2, 2, 2 ], {} ); // $ExpectError
+	quaternary3d( [ x, y, z, w, out ], [ 1, 2, 2 ], 'abc' ); // $ExpectError
+	quaternary3d( [ x, y, z, w, out ], [ 1, 2, 2 ], 3.14 ); // $ExpectError
+	quaternary3d( [ x, y, z, w, out ], [ 1, 2, 2 ], true ); // $ExpectError
+	quaternary3d( [ x, y, z, w, out ], [ 1, 2, 2 ], false ); // $ExpectError
+	quaternary3d( [ x, y, z, w, out ], [ 1, 2, 2 ], null ); // $ExpectError
+	quaternary3d( [ x, y, z, w, out ], [ 1, 2, 2 ], [ '1' ] ); // $ExpectError
+	quaternary3d( [ x, y, z, w, out ], [ 1, 2, 2 ], {} ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...
@@ -102,5 +102,5 @@ function fcn( x: number, y: number, z: number, w: number ): number {
 
 	quaternary3d(); // $ExpectError
 	quaternary3d( [ x, y, z, w, out ] ); // $ExpectError
-	quaternary3d( [ x, y, z, w, out ], [ 2, 2, 2 ], fcn, {} ); // $ExpectError
+	quaternary3d( [ x, y, z, w, out ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError
 }

base/quaternary4d/README.md

@@ -0,0 +1,128 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2023 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.
+
+-->
+
+# quaternary4d
+
+> Apply a quaternary callback to elements in four four-dimensional nested input arrays and assign results to elements in a four-dimensional nested output array.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var quaternary4d = require( '@stdlib/array/base/quaternary4d' );
+```
+
+#### quaternary4d( arrays, shape, fcn )
+
+Applies a quaternary callback to elements in four four-dimensional nested input arrays and assigns results to elements in a four-dimensional nested output array.
+
+```javascript
+var add = require( '@stdlib/math/base/ops/add4' );
+var zeros4d = require( '@stdlib/array/base/zeros4d' );
+
+var x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ];
+var out = zeros4d( [ 1, 1, 2, 2 ] );
+
+var shape = [ 1, 1, 2, 2 ];
+
+quaternary4d( [ x, x, x, x, out ], shape, add );
+// out => [ [ [ [ 4.0, 8.0 ], [ 12.0, 16.0 ] ] ] ]
+```
+
+The function accepts the following arguments:
+
+-   **arrays**: array-like object containing four input nested arrays and one output nested array.
+-   **shape**: array shape.
+-   **fcn**: quaternary function to apply.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The function assumes that the input and output arrays have the same shape.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var filled4dBy = require( '@stdlib/array/base/filled4d-by' );
+var zeros4d = require( '@stdlib/array/base/zeros4d' );
+var add = require( '@stdlib/math/base/ops/add4' );
+var quaternary4d = require( '@stdlib/array/base/quaternary4d' );
+
+var shape = [ 1, 3, 3, 3 ];
+
+var x = filled4dBy( shape, discreteUniform( -100, 100 ) );
+console.log( x );
+
+var y = filled4dBy( shape, discreteUniform( -100, 100 ) );
+console.log( y );
+
+var z = filled4dBy( shape, discreteUniform( -100, 100 ) );
+console.log( z );
+
+var w = filled4dBy( shape, discreteUniform( -100, 100 ) );
+console.log( w );
+
+var out = zeros4d( shape );
+console.log( out );
+
+quaternary4d( [ x, y, z, w, out ], shape, 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">
+
+</section>
+
+<!-- /.links -->

base/quaternary4d/benchmark/benchmark.js

@@ -0,0 +1,128 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 filled4dBy = require( './../../../base/filled4d-by' );
+var zeros4d = require( './../../../base/zeros4d' );
+var numel = require( '@stdlib/ndarray/base/numel' );
+var add = require( '@stdlib/math/base/ops/add4' );
+var pkg = require( './../package.json' ).name;
+var quaternary4d = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveIntegerArray} shape - array shape
+* @returns {Function} benchmark function
+*/
+function createBenchmark( shape ) {
+	var arrays;
+	var out;
+	var x;
+	var y;
+	var z;
+	var w;
+
+	x = filled4dBy( shape, uniform( -100.0, 100.0 ) );
+	y = filled4dBy( shape, uniform( -100.0, 100.0 ) );
+	z = filled4dBy( shape, uniform( -100.0, 100.0 ) );
+	w = filled4dBy( shape, uniform( -100.0, 100.0 ) );
+	out = zeros4d( shape );
+
+	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 i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			quaternary4d( arrays, shape, add );
+			i3 = i % shape[ 0 ];
+			i2 = i % shape[ 1 ];
+			i1 = i % shape[ 2 ];
+			i0 = i % shape[ 3 ];
+			if ( isnan( arrays[ 4 ][ i3 ][ i2 ][ i1 ][ i0 ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+
+		i3 = i % shape[ 0 ];
+		i2 = i % shape[ 1 ];
+		i1 = i % shape[ 2 ];
+		i0 = i % shape[ 3 ];
+		if ( isnan( arrays[ 4 ][ 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/4.0 ) );
+		sh = [ N, N, N, N ];
+		f = createBenchmark( sh );
+		bench( pkg+'::equidimensional:size='+numel( sh ), f );
+	}
+}
+
+main();

base/quaternary4d/docs/repl.txt

@@ -0,0 +1,34 @@
+
+{{alias}}( arrays, shape, fcn )
+    Applies a quaternary callback to elements in four four-dimensional nested
+    input arrays and assigns results to elements in a four-dimensional nested
+    output array.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject
+        Array-like object containing four input nested arrays and one output
+        nested array.
+
+    shape: Array<integer>
+        Array shape.
+
+    fcn: Function
+        Quaternary callback.
+
+    Examples
+    --------
+    > function fcn( x, y, z, w ) { return x + y + z + w; };
+    > var x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ];
+    > var y = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ];
+    > var z = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ];
+    > var w = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ];
+    > var out = [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ];
+    > var shape = [ 1, 1, 2, 2 ];
+    > {{alias}}( [ x, y, z, w, out ], shape, fcn );
+    > out
+    [ [ [ [ 4.0, 8.0 ], [ 12.0, 16.0 ] ] ] ]
+
+    See Also
+    --------
+