Auto-generated commit

base/lib/index.js

@@ -585,6 +585,15 @@ setReadOnly( ns, 'map3d', require( './../../base/map3d' ) );
 */
 setReadOnly( ns, 'map4d', require( './../../base/map4d' ) );
 
+/**
+* @name map5d
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/array/base/map5d}
+*/
+setReadOnly( ns, 'map5d', require( './../../base/map5d' ) );
+
 /**
 * @name mskbinary2d
 * @memberof ns

base/map5d/README.md

@@ -0,0 +1,166 @@
+<!--
+
+@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.
+
+-->
+
+# map5d
+
+> Apply a function to elements in a five-dimensional nested input array and assign results to elements in a new five-dimensional nested output array.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var map5d = require( '@stdlib/array/base/map5d' );
+```
+
+#### map5d( x, shape, fcn\[, thisArg] )
+
+Applies a function to elements in a five-dimensional nested input array and assigns results to elements in a new five-dimensional nested output array.
+
+```javascript
+var naryFunction = require( '@stdlib/utils/nary-function' );
+var abs = require( '@stdlib/math/base/special/abs' );
+
+var x = [ [ [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ] ] ];
+var shape = [ 1, 1, 1, 2, 2 ];
+
+var y = map5d( x, shape, naryFunction( abs, 1 ) );
+// returns [ [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ] ]
+```
+
+The function accepts the following arguments:
+
+-   **x**: input nested array.
+-   **shape**: array shape.
+-   **fcn**: function to apply.
+-   **thisArg**: applied function execution context (_optional_).
+
+To set the applied function's execution context, provide a `thisArg`.
+
+<!-- eslint-disable no-invalid-this -->
+
+```javascript
+function fcn( x ) {
+    this.count += 1;
+    return x;
+}
+
+var x = [ [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ] ];
+var shape = [ 1, 1, 1, 2, 2 ];
+
+var ctx = {
+    'count': 0
+};
+
+var y = map5d( x, shape, fcn, ctx );
+// returns [ [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ] ]
+
+var v = ctx.count;
+// returns 4
+```
+
+#### map5d.assign( x, y, shape, fcn\[, thisArg] )
+
+Applies a function to elements in a five-dimensional nested input array and assigns results to elements in a five-dimensional nested output array.
+
+```javascript
+var naryFunction = require( '@stdlib/utils/nary-function' );
+var zeros5d = require( '@stdlib/array/base/zeros5d' );
+var abs = require( '@stdlib/math/base/special/abs' );
+
+var x = [ [ [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ] ] ];
+var shape = [ 1, 1, 1, 2, 2 ];
+
+var y = zeros5d( shape );
+
+var out = map5d.assign( x, y, shape, naryFunction( abs, 1 ) );
+// returns [ [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ] ]
+
+var bool = ( out === y );
+// returns true
+```
+
+The function accepts the following arguments:
+
+-   **x**: input nested array.
+-   **y**: output nested array.
+-   **shape**: array shape.
+-   **fcn**: function to apply.
+-   **thisArg**: applied function execution context (_optional_).
+
+The function assumes that the input and output arrays have the same shape.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+</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 naryFunction = require( '@stdlib/utils/nary-function' );
+var abs = require( '@stdlib/math/base/special/abs' );
+var map5d = require( '@stdlib/array/base/map5d' );
+
+var shape = [ 1, 1, 3, 3, 3 ];
+
+var x = filled5dBy( shape, discreteUniform( -100, 100 ) );
+console.log( x );
+
+var y = map5d( x, shape, naryFunction( abs, 1 ) );
+console.log( y );
+```
+
+</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/map5d/benchmark/benchmark.assign.js

@@ -0,0 +1,123 @@
+/**
+* @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 identity = require( '@stdlib/math/base/special/identity' );
+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 map5d = require( './../lib' ).assign;
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveIntegerArray} shape - array shape
+* @returns {Function} benchmark function
+*/
+function createBenchmark( shape ) {
+	var x;
+	var y;
+
+	x = filled5dBy( shape, uniform( -100.0, 100.0 ) );
+	y = zeros5d( shape );
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i0;
+		var i1;
+		var i2;
+		var i3;
+		var i4;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = map5d( x, y, shape, identity );
+			i4 = i % shape[ 0 ];
+			i3 = i % shape[ 1 ];
+			i2 = i % shape[ 2 ];
+			i1 = i % shape[ 3 ];
+			i0 = i % shape[ 4 ];
+			if ( isnan( out[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+
+		i4 = i % shape[ 0 ];
+		i3 = i % shape[ 1 ];
+		i2 = i % shape[ 2 ];
+		i1 = i % shape[ 3 ];
+		i0 = i % shape[ 4 ];
+		if ( isnan( out[ 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:assign:size='+numel( sh ), f );
+	}
+}
+
+main();