at5d

Return an element from a five-dimensional nested array.

Usage

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

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

Returns 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 );
Did you find this page helpful?