map3d

Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.

Usage

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

map3d( x, shape, fcn[, thisArg] )

Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array.

var naryFunction = require( '@stdlib/utils/nary-function' );
var abs = require( '@stdlib/math/base/special/abs' );

var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ];
var shape = [ 1, 2, 2 ];

var y = map3d( x, shape, naryFunction( abs, 1 ) );
// returns [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]

The function accepts the following arguments:

x: input nested array.
shape: array shape.
fcn: function to apply.
thisArg: applied function execution context (optional).

To set the applied function's execution context, provide a thisArg.

function fcn( x ) {
    this.count += 1;
    return x;
}

var x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ];
var shape = [ 1, 2, 2 ];

var ctx = {
    'count': 0
};

var y = map3d( x, shape, fcn, ctx );
// returns [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]

var v = ctx.count;
// returns 4

map3d.assign( x, y, shape, fcn[, thisArg] )

Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.

var naryFunction = require( '@stdlib/utils/nary-function' );
var zeros3d = require( '@stdlib/array/base/zeros3d' );
var abs = require( '@stdlib/math/base/special/abs' );

var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ];
var shape = [ 1, 2, 2 ];

var y = zeros3d( shape );

var out = map3d.assign( x, y, shape, naryFunction( abs, 1 ) );
// returns [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]

var bool = ( out === y );
// returns true

The function accepts the following arguments:

x: input nested array.
y: output nested array.
shape: array shape.
fcn: function to apply.
thisArg: applied function execution context (optional).

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

Examples

var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filled3dBy = require( '@stdlib/array/base/filled3d-by' );
var naryFunction = require( '@stdlib/utils/nary-function' );
var abs = require( '@stdlib/math/base/special/abs' );
var map3d = require( '@stdlib/array/base/map3d' );

var shape = [ 3, 3, 3 ];

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

var y = map3d( x, shape, naryFunction( abs, 1 ) );
console.log( y );