filled3dBy

Create a filled three-dimensional nested array according to a provided callback function.

Usage

var filled3dBy = require( '@stdlib/array/base/filled3d-by' );

filled3dBy( shape, clbk[, thisArg] )

Returns a filled three-dimensional nested array according to a provided callback function.

function clbk() {
    return 1.0;
}

var out = filled3dBy( [ 2, 1, 3 ], clbk );
// returns [ [ [ 1.0, 1.0, 1.0 ] ], [ [ 1.0, 1.0, 1.0 ] ] ]

When invoked, a callback function is provided a single argument:

  • indices: current array element indices.

To set the callback execution context, provide a thisArg.

function clbk() {
    this.count += 1;
    return 1.0;
}

var ctx = {
    'count': 0
};

var out = filled3dBy( [ 1, 2, 3 ], clbk, ctx );
// returns [ [ [ 1.0, 1.0, 1.0 ], [ 1.0, 1.0, 1.0 ] ] ];

var cnt = ctx.count;
// returns 6

Examples

var constantFunction = require( '@stdlib/utils/constant-function' );
var filled3dBy = require( '@stdlib/array/base/filled3d-by' );

var out = filled3dBy( [ 1, 1, 3 ], constantFunction( 0.0 ) );
// returns [ [ [ 0.0, 0.0, 0.0 ] ] ]

out = filled3dBy( [ 1, 3, 1 ], constantFunction( 'beep' ) );
// returns [ [ [ 'beep' ], [ 'beep' ], [ 'beep' ] ] ]

out = filled3dBy( [ 1, 1, 3 ], constantFunction( null ) );
// returns [ [ [ null, null, null ] ] ]

out = filled3dBy( [ 1, 3, 1 ], constantFunction( true ) );
// returns [ [ [ true ], [ true ], [ true ] ] ]

out = filled3dBy( [ 1, 1, 3 ], constantFunction( void 0 ) );
// returns [ [ [ undefined, undefined, undefined ] ] ]
Did you find this page helpful?