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!

at5d

Return an element from a five-dimensional nested array.

Installation

npm install @stdlib/array-base-at5d

Alternatively,

To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
If you are using Deno, visit the deno branch (see README for usage intructions).
For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

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

at5d( x, i0, i1, i2, i3, i4 )

Return an element from a five-dimensional nested array.

var x = [ [ [ [ [ 1, 2 ], [ 3, 4 ] ] ] ] ];

var out = at5d( x, 0, 0, 0, 0, 1 );
// returns 2

out = at5d( x, 0, 0, 0, 1, 0 );
// returns 3

The function accepts the following arguments:

x: five-dimensional nested input array.
i0: first dimension index.
i1: second dimension index.
i2: third dimension index.
i3: fourth dimension index.
i4: fifth dimension index.

Notes

Negative indices are resolved relative to the last element along the respective dimension, with the last element corresponding to -1.
If provided out-of-bounds indices, the function always returns undefined.

Examples

var papply = require( '@stdlib/utils-papply' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var filled5dBy = require( '@stdlib/array-base-filled5d-by' );
var quinary5d = require( '@stdlib/array-base-quinary5d' );
var zeros5d = require( '@stdlib/array-base-zeros5d' );
var at5d = require( '@stdlib/array-base-at5d' );

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

// Define a nested input array:
var x = filled5dBy( shape, discreteUniform( -100, 100 ) );
console.log( x );

// Define arrays containing random index values:
var i0 = filled5dBy( shape, discreteUniform( -shape[0], shape[0]-1 ) );
console.log( i0 );

var i1 = filled5dBy( shape, discreteUniform( -shape[1], shape[1]-1 ) );
console.log( i1 );

var i2 = filled5dBy( shape, discreteUniform( -shape[2], shape[2]-1 ) );
console.log( i2 );

var i3 = filled5dBy( shape, discreteUniform( -shape[3], shape[3]-1 ) );
console.log( i3 );

var i4 = filled5dBy( shape, discreteUniform( -shape[4], shape[4]-1 ) );
console.log( i4 );

// Define an output array:
var out = zeros5d( shape );
console.log( out );

// Fill the output array with randomly selected values from the input array:
quinary5d( [ i0, i1, i2, i3, i4, out ], shape, papply( at5d, x ) );
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.

stdlib-js/array-base-at5d