Skip to content

Latest commit

 

History

History
276 lines (179 loc) · 8.49 KB

File metadata and controls

276 lines (179 loc) · 8.49 KB
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!

bquinary2d

NPM version Build Status Coverage Status

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

Usage

To use in Observable,

bquinary2d = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-broadcasted-quinary2d@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var bquinary2d = require( 'path/to/vendor/umd/array-base-broadcasted-quinary2d/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/array-base-broadcasted-quinary2d@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.bquinary2d;
})();
</script>

bquinary2d( arrays, shapes, fcn )

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

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

function add( x, y, z, w, v ) {
    return x + y + z + w + v;
}

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

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

bquinary2d( [ x, y, z, w, v, out ], shapes, add );
// out => [ [ 12.0, 13.0 ], [ 13.0, 14.0 ] ]

The function accepts the following arguments:

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

Notes

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

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform@umd/browser.js"></script>
<script type="text/javascript">
(function () {.factory;
var filled2dBy = require( '@stdlib/array-base-filled2d-by' );
var zeros2d = require( '@stdlib/array-base-zeros2d' );
var bquinary2d = require( '@stdlib/array-base-broadcasted-quinary2d' );

function add( x, y, z, w, v ) {
    return x + y + z + w + v;
}

var shapes = [
    [ 1, 3 ],
    [ 3, 1 ],
    [ 1, 1 ],
    [ 3, 3 ],
    [ 1, 3 ],
    [ 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 w = filled2dBy( shapes[ 3 ], discreteUniform( -100, 100 ) );
console.log( w );

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

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

bquinary2d( [ x, y, z, w, v, out ], shapes, add );
console.log( out );

})();
</script>
</body>
</html>

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.