Skip to content

Latest commit

 

History

History
248 lines (155 loc) · 7.67 KB

README.md

File metadata and controls

248 lines (155 loc) · 7.67 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!

quinary3d

NPM version Build Status Coverage Status

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

Usage

To use in Observable,

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

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

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

To include the bundle in a webpage,

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

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

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

quinary3d( arrays, shape, fcn )

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

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

var x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ];
var out = zeros3d( [ 1, 2, 2 ] );

var shape = [ 1, 2, 2 ];

quinary3d( [ x, x, x, x, x, out ], shape, add );
// out => [ [ [ 5.0, 10.0 ], [ 15.0, 20.0 ] ] ]

The function accepts the following arguments:

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

Notes

  • The function assumes that the input and output arrays have the same shape.

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 filled3dBy = require( '@stdlib/array-base-filled3d-by' );
var zeros3d = require( '@stdlib/array-base-zeros3d' );
var add = require( '@stdlib/math-base-ops-add5' );
var quinary3d = require( '@stdlib/array-base-quinary3d' );

var shape = [ 3, 3, 3 ];

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

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

var z = filled3dBy( shape, discreteUniform( -100, 100 ) );
console.log( z );

var w = filled3dBy( shape, discreteUniform( -100, 100 ) );
console.log( w );

var v = filled3dBy( shape, discreteUniform( -100, 100 ) );
console.log( v );

var out = zeros3d( shape );
console.log( out );

quinary3d( [ x, y, z, w, v, out ], shape, 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.