https://github.com/stdlib-js/array-base-map3d
Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.
https://github.com/stdlib-js/array-base-map3d
3d apply array base foreach javascript map matrix multidimensional ndarray node node-js nodejs stdlib transform
Last synced: 7 months ago
JSON representation
Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-base-map3d
- Owner: stdlib-js
- License: apache-2.0
- Created: 2023-11-22T22:07:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T11:29:48.000Z (over 1 year ago)
- Last Synced: 2024-12-01T12:33:15.096Z (over 1 year ago)
- Topics: 3d, apply, array, base, foreach, javascript, map, matrix, multidimensional, ndarray, node, node-js, nodejs, stdlib, transform
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 246 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
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.
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.
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.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# map3d
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.
## Installation
```bash
npm install @stdlib/array-base-map3d
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var map3d = require( '@stdlib/array-base-map3d' );
```
#### map3d( x, shape, fcn\[, thisArg] )
Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-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, 2, 2 ];
var y = map3d( 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`.
```javascript
function fcn( x ) {
this.count += 1;
return x;
}
var x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ];
var shape = [ 1, 2, 2 ];
var ctx = {
'count': 0
};
var y = map3d( x, shape, fcn, ctx );
// returns [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]
var v = ctx.count;
// returns 4
```
#### map3d.assign( x, y, shape, fcn\[, thisArg] )
Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.
```javascript
var naryFunction = require( '@stdlib/utils-nary-function' );
var zeros3d = require( '@stdlib/array-base-zeros3d' );
var abs = require( '@stdlib/math-base-special-abs' );
var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ];
var shape = [ 1, 2, 2 ];
var y = zeros3d( shape );
var out = map3d.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.
## Examples
```javascript
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var filled3dBy = require( '@stdlib/array-base-filled3d-by' );
var naryFunction = require( '@stdlib/utils-nary-function' );
var abs = require( '@stdlib/math-base-special-abs' );
var map3d = require( '@stdlib/array-base-map3d' );
var shape = [ 3, 3, 3 ];
var x = filled3dBy( shape, discreteUniform( -100, 100 ) );
console.log( x );
var y = map3d( x, shape, naryFunction( abs, 1 ) );
console.log( y );
```
* * *
## 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 © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/array-base-map3d.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-base-map3d
[test-image]: https://github.com/stdlib-js/array-base-map3d/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-base-map3d/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-map3d/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-base-map3d?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[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/array-base-map3d/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-base-map3d/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-base-map3d/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-map3d/main/LICENSE