External module "ndarray/base/broadcast-array/docs/types/index.d"

Export assignment broadcastArray

• broadcastArray(arr: ndarray, shape: ArrayLike<number>): ndarray

• Broadcasts an ndarray to a specified shape.

  Notes

  • The function throws an error if a provided ndarray is incompatible with a provided shape.
  • The returned array is a view on the input array data buffer. The view is typically not contiguous. As more than one element of a returned view may refer to the same memory location, writing to the view may affect multiple elements. If you need to write to the returned array, copy the array before performing operations which may mutate elements.
  • The returned array is a "base" ndarray, and, thus, the returned array does not perform bounds checking or afford any of the guarantees of the non-base ndarray constructor. The primary intent of this function is to broadcast an ndarray-like object within internal implementations and to do so with minimal overhead.
  • The function always returns a new ndarray instance even if the input ndarray shape and the desired shape are the same.

  throws

  input array cannot have more dimensions than the desired shape

  throws

  input array dimension sizes must be 1 or equal to the corresponding dimension in the provided shape

  Parameters

  • arr: ndarray

    input array

  • shape: ArrayLike<number>

    desired shape

  Returns ndarray

  broadcasted 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 = broadcastArray( x, [ 3, 2, 2 ] );
  // returns <ndarray>
  
  var shy = y.shape;
  // returns [ 3, 2, 2 ]
  
  var v = y.get( 0, 0, 0 );
  // returns 1
  
  v = y.get( 0, 0, 1 );
  // returns 2
  
  v = y.get( 1, 0, 0 );
  // returns 1
  
  v = y.get( 1, 1, 0 );
  // returns 3
  
  v = y.get( 2, 0, 0 );
  // returns 1
  
  v = y.get( 2, 1, 1 );
  // returns 4