External module "ndarray/base/prepend-singleton-dimensions/docs/types/index.d"

Export assignment prependSingletonDimensions

• prependSingletonDimensions(x: ndarray, n: number): ndarray

• Returns an array with a specified number of prepended singleton dimensions.

  Parameters

  • x: ndarray

    input array

  • n: number

    number of singleton dimensions to prepend

  Returns ndarray

  output array

  Example

  var array = require( `@stdlib/ndarray/array` );
  
  var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
  // returns <ndarray>
  
  var shx = x.shape;
  // returns [ 2, 2 ]
  
  var y = prependSingletonDimensions( x, 3 );
  // returns <ndarray>
  
  var shy = y.shape;
  // returns [ 1, 1, 1, 2, 2 ]
  
  var v = y.get( 0, 0, 0, 0, 0 );
  // returns 1
  
  v = y.get( 0, 0, 0, 0, 1 );
  // returns 2
  
  v = y.get( 0, 0, 0, 1, 0 );
  // returns 3
  
  v = y.get( 0, 0, 0, 1, 1 );
  // returns 4