@stdlib/array-base-broadcasted-ternary2d

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!

bternary2d

Apply a ternary callback to elements in three broadcasted nested input arrays and assign results to elements in a two-dimensional nested output array.

Installation

npm install @stdlib/array-base-broadcasted-ternary2d

Usage

var bternary2d = require( '@stdlib/array-base-broadcasted-ternary2d' );

bternary2d( arrays, shapes, fcn )

Applies a ternary callback to elements in three broadcasted nested input arrays and assigns results to elements in a two-dimensional nested output array.

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

var x = [ [ 1.0, 2.0 ] ];
var y = [ [ 3.0 ], [ 4.0 ] ];
var z = [ [ 5.0 ] ];
var out = zeros2d( [ 2, 2 ] );

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

bternary2d( [ x, y, z, out ], shapes, add );
// out => [ [ 9.0, 10.0 ], [ 10.0, 11.0 ] ]

The function accepts the following arguments:

• arrays: array-like object containing three input nested arrays and one output nested array.
• shapes: array shapes.
• fcn: ternary function to apply.

Notes

• The input and output array shapes must be broadcast compatible.

Examples

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var filled2dBy = require( '@stdlib/array-base-filled2d-by' );
var zeros2d = require( '@stdlib/array-base-zeros2d' );
var add = require( '@stdlib/math-base-ops-add3' );
var bternary2d = require( '@stdlib/array-base-broadcasted-ternary2d' );

var shapes = [
    [ 1, 3 ],
    [ 3, 1 ],
    [ 1, 1 ],
    [ 3, 3 ]
];

var x = filled2dBy( shapes[ 0 ], discreteUniform( -100, 100 ) );
console.log( x );

var y = filled2dBy( shapes[ 1 ], discreteUniform( -100, 100 ) );
console.log( y );

var z = filled2dBy( shapes[ 2 ], discreteUniform( -100, 100 ) );
console.log( z );

var out = zeros2d( shapes[ 3 ] );
console.log( out );

bternary2d( [ x, y, z, out ], shapes, add );
console.log( out );

---

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

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.