npm package: @stdlib/utils-map5d
Description: Apply a function to each nested element in a five-dimensional nested array and assign the result to a nested element in a new five-dimensional nested array.
Author: The Stdlib Authors
Latest version: 0.2.3

<!--

@license Apache-2.0

Copyright (c) 2021 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.

-->


<details>
  <summary>
    About stdlib...
  </summary>
  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
</details>

# map5d

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->

> Apply a function to each nested element in a five-dimensional nested array and assign the result to a nested element in a new five-dimensional nested array.

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="installation">

## Installation

```bash
npm install @stdlib/utils-map5d
```

</section>

<section class="usage">

## Usage

```javascript
var map5d = require( '@stdlib/utils-map5d' );
```

#### map5d( arr, fcn\[, thisArg] )

Applies a function to each nested element in a five-dimensional nested array and assigns the result to a nested element in a new five-dimensional nested array.

```javascript
var naryFunction = require( '@stdlib/utils-nary-function' );
var abs = require( '@stdlib/math-base-special-abs' );

var arr = [
    [ [ [ [ -1, -2, -3 ] ] ] ],
    [ [ [ [ -4, -5, -6 ] ] ] ]
];

var out = map5d( arr, naryFunction( abs, 1 ) );
// returns [ [ [ [ [ 1, 2, 3 ] ] ] ], [ [ [ [ 4, 5, 6 ] ] ] ] ]
```

The applied function is provided the following arguments:

-   **value**: array element.
-   **indices**: current array element indices.
-   **arr**: input array.

To set the `this` context when invoking the input function, provide a `thisArg`.

<!-- eslint-disable no-invalid-this -->

```javascript
var abs = require( '@stdlib/math-base-special-abs' );

function fcn( v ) {
    this.count += 1;
    return abs( v );
}

var arr = [
    [ [ [ [ -1 ], [ -2 ], [ -3 ] ] ] ],
    [ [ [ [ -4 ], [ -5 ], [ -6 ] ] ] ]
];

var ctx = {
    'count': 0
};

var out = map5d( arr, fcn, ctx );
// returns [ [ [ [ [ 1 ], [ 2 ], [ 3 ] ] ] ], [ [ [ [ 4 ], [ 5 ], [ 6 ] ] ] ] ]

var cnt = ctx.count;
// returns 6
```

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

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

```javascript
var filledarrayBy = require( '@stdlib/array-filled-by' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var naryFunction = require( '@stdlib/utils-nary-function' );
var abs2 = require( '@stdlib/math-base-special-abs2' );
var map5d = require( '@stdlib/utils-map5d' );

function fill( n ) {
    if ( n > 0 ) {
        return array;
    }
    return values;

    function array() {
        return filledarrayBy( 2, 'generic', fill( n-1 ) );
    }

    function values( i ) {
        var rand = discreteUniform( -10*(i+1), 10*(i+1) );
        return filledarrayBy( 10, 'generic', rand );
    }
}

// Create a five-dimensional nested array:
var x = filledarrayBy( 2, 'generic', fill( 3 ) );

// Create an explicit unary function:
var f = naryFunction( abs2, 1 );

// Compute the element-wise squared absolute value...
var y = map5d( x, f );

console.log( 'x:' );
console.log( JSON.stringify( x, null, '  ' ) );

console.log( 'y:' );
console.log( JSON.stringify( y, null, '  ' ) );
```

</section>

<!-- /.examples -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

* * *

## See Also

-   <span class="package-name">[`@stdlib/utils-map`][@stdlib/utils/map]</span><span class="delimiter">: </span><span class="description">apply a function to each element in an array and assign the result to an element in an output array.</span>
-   <span class="package-name">[`@stdlib/utils-map2d`][@stdlib/utils/map2d]</span><span class="delimiter">: </span><span class="description">apply a function to each nested element in an array of arrays and assign the result to a nested element in a new array of arrays.</span>
-   <span class="package-name">[`@stdlib/utils-map3d`][@stdlib/utils/map3d]</span><span class="delimiter">: </span><span class="description">apply a function to each nested element in a three-dimensional nested array and assign the result to a nested element in a new three-dimensional nested array.</span>
-   <span class="package-name">[`@stdlib/utils-map4d`][@stdlib/utils/map4d]</span><span class="delimiter">: </span><span class="description">apply a function to each nested element in a four-dimensional nested array and assign the result to a nested element in a new four-dimensional nested array.</span>

</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="main-repo" >

* * *

## Notice

This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].


## Copyright

Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].

</section>

<!-- /.stdlib -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-map5d.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-map5d

[test-image]: https://github.com/stdlib-js/utils-map5d/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/utils-map5d/actions/workflows/test.yml?query=branch:v0.2.3

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-map5d/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-map5d?branch=main

<!--

[dependencies-image]: https://img.shields.io/david/stdlib-js/utils-map5d.svg
[dependencies-url]: https://david-dm.org/stdlib-js/utils-map5d/main

-->

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/utils-map5d/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-map5d/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-map5d/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-map5d/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-map5d/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-map5d/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-map5d/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-map5d/main/LICENSE

<!-- <related-links> -->

[@stdlib/utils/map]: https://www.npmjs.com/package/@stdlib/utils-map

[@stdlib/utils/map2d]: https://www.npmjs.com/package/@stdlib/utils-map2d

[@stdlib/utils/map3d]: https://www.npmjs.com/package/@stdlib/utils-map3d

[@stdlib/utils/map4d]: https://www.npmjs.com/package/@stdlib/utils-map4d

<!-- </related-links> -->

</section>

<!-- /.links -->