https://github.com/stdlib-js/array-base-mskbinary4d
Apply a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assign results to elements in a four-dimensional nested output array.
https://github.com/stdlib-js/array-base-mskbinary4d
4d apply array base binary foreach javascript map mask masked matrix multidimensional ndarray node node-js nodejs skip skipped stdlib transform
Last synced: 7 months ago
JSON representation
Apply a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assign results to elements in a four-dimensional nested output array.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-base-mskbinary4d
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-11-25T00:42:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-21T17:46:36.000Z (7 months ago)
- Last Synced: 2025-09-21T19:30:46.862Z (7 months ago)
- Topics: 4d, apply, array, base, binary, foreach, javascript, map, mask, masked, matrix, multidimensional, ndarray, node, node-js, nodejs, skip, skipped, stdlib, transform
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 412 KB
- Stars: 1
- Watchers: 2
- 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
- Notice: NOTICE
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!
# mskbinary4d
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Apply a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assign results to elements in a four-dimensional nested output array.
## Installation
```bash
npm install @stdlib/array-base-mskbinary4d
```
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 mskbinary4d = require( '@stdlib/array-base-mskbinary4d' );
```
#### mskbinary4d( arrays, shape, fcn )
Applies a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assigns results to elements in a four-dimensional nested output array.
```javascript
var add = require( '@stdlib/number-float64-base-add' );
var zeros4d = require( '@stdlib/array-base-zeros4d' );
var x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ];
var z = zeros4d( [ 1, 1, 2, 2 ] );
var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ];
var shape = [ 1, 1, 2, 2 ];
mskbinary4d( [ x, x, mask, z ], shape, add );
// z => [ [ [ [ 2.0, 0.0 ], [ 6.0, 8.0 ] ] ] ]
```
The function accepts the following arguments:
- **arrays**: array-like object containing two input nested arrays, an input nested mask array, and one output nested array.
- **shape**: array shape.
- **fcn**: binary function to apply.
## Notes
- 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 bernoulli = require( '@stdlib/random-base-bernoulli' ).factory;
var filled4dBy = require( '@stdlib/array-base-filled4d-by' );
var zeros4d = require( '@stdlib/array-base-zeros4d' );
var add = require( '@stdlib/number-float64-base-add' );
var mskbinary4d = require( '@stdlib/array-base-mskbinary4d' );
var shape = [ 2, 1, 3, 3 ];
var x = filled4dBy( shape, discreteUniform( -100, 100 ) );
console.log( x );
var y = filled4dBy( shape, discreteUniform( -100, 100 ) );
console.log( y );
var mask = filled4dBy( shape, bernoulli( 0.5 ) );
console.log( mask );
var z = zeros4d( shape );
console.log( z );
mskbinary4d( [ x, y, mask, z ], shape, add );
console.log( z );
```
* * *
## 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-mskbinary4d.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-base-mskbinary4d
[test-image]: https://github.com/stdlib-js/array-base-mskbinary4d/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-base-mskbinary4d/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-mskbinary4d/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-base-mskbinary4d?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-mskbinary4d/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-base-mskbinary4d/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-base-mskbinary4d/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-base-mskbinary4d/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-base-mskbinary4d/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-base-mskbinary4d/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-base-mskbinary4d/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-mskbinary4d/main/LICENSE