prependSingletonDimensions

Prepend singleton dimensions.

Usage

var prependSingletonDimensions = require( '@stdlib/ndarray/base/prepend-singleton-dimensions' );

prependSingletonDimensions( x, n )

Returns an ndarray with a specified number of prepended singleton dimensions (i.e., dimensions whose size is equal to 1).

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

// Create a 2x2 ndarray:
var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
// returns <ndarray>

// Prepend singleton dimensions:
var y = prependSingletonDimensions( x, 3 );
// returns <ndarray>

var sh = y.shape;
// returns [ 1, 1, 1, 2, 2 ]

Examples

var array = require( '@stdlib/ndarray/array' );
var numel = require( '@stdlib/ndarray/base/numel' );
var ind2sub = require( '@stdlib/ndarray/ind2sub' );
var prependSingletonDimensions = require( '@stdlib/ndarray/base/prepend-singleton-dimensions' );

// Create a 2-dimensional array:
var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
// returns <ndarray>

// Prepend singleton dimensions:
var y = prependSingletonDimensions( x, 3 );
// returns <ndarray>

// Retrieve the shape:
var sh = y.shape;
// returns [ 1, 1, 1, 2, 2 ]

// Retrieve the number of elements:
var N = numel( sh );

// Loop through the array elements...
var i;
for ( i = 0; i < N; i++ ) {
    console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) );
}