0.2.1 • Published 2 months ago

@stdlib/array-base-binary5d v0.2.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 months ago

binary5d

NPM version Build Status Coverage Status

Apply a binary callback to elements in two five-dimensional nested input arrays and assign results to elements in a five-dimensional nested output array.

Installation

npm install @stdlib/array-base-binary5d

Usage

var binary5d = require( '@stdlib/array-base-binary5d' );

binary5d( arrays, shape, fcn )

Applies a binary callback to elements in two five-dimensional nested input arrays and assigns results to elements in a five-dimensional nested output array.

var add = require( '@stdlib/math-base-ops-add' );
var zeros5d = require( '@stdlib/array-base-zeros5d' );

var x = [ [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ] ];
var z = zeros5d( [ 1, 1, 1, 2, 2 ] );

var shape = [ 1, 1, 1, 2, 2 ];

binary5d( [ x, x, z ], shape, add );
// z => [ [ [ [ [ 2.0, 4.0 ], [ 6.0, 8.0 ] ] ] ] ]

The function accepts the following arguments:

  • arrays: array-like object containing two input nested arrays 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

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var filled5dBy = require( '@stdlib/array-base-filled5d-by' );
var zeros5d = require( '@stdlib/array-base-zeros5d' );
var add = require( '@stdlib/math-base-ops-add' );
var binary5d = require( '@stdlib/array-base-binary5d' );

var shape = [ 1, 2, 2, 3, 3 ];

var x = filled5dBy( shape, discreteUniform( -100, 100 ) );
console.log( x );

var y = filled5dBy( shape, discreteUniform( -100, 100 ) );
console.log( y );

var z = zeros5d( shape );
console.log( z );

binary5d( [ x, y, z ], shape, add );
console.log( z );

Notice

This package is part of 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, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.