README.md

atleastnd

Convert the inputs to ndarrays having at least the provided number of dimensions.

Usage

var atleastnd = require( '@stdlib/ndarray/base/atleastnd' );

atleastnd( ndims, arrays )

Converts the inputs to ndarrays having at least the provided number of dimensions.

var array = require( '@stdlib/ndarray/array' );

var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ] ] );
// returns <ndarray>[ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ] ]

var y = array( [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ] );
// returns <ndarray>[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]

var out = atleastnd( 3, [ x, y ] );
// returns [ <ndarray>, <ndarray> ]

The function accepts the following arguments:

• ndims: minimum number of dimensions.
• arrays: array-like object containing a list of arrays.

Examples

var discreteUniform = require( '@stdlib/random/discrete-uniform' );
var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
var atleastnd = require( '@stdlib/ndarray/base/atleastnd' );

var x = discreteUniform( [ 2, 2, 2 ], -100, 100 );
// returns <ndarray>

var y = discreteUniform( [ 5, 2 ], -100, 100 );
// returns <ndarray>

var out = atleastnd( 3, [ x, y ] );
// returns [ <ndarray>, <ndarray> ]

console.log( ndarray2array( out[ 0 ] ) );
console.log( ndarray2array( out[ 1 ] ) );