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

Export assignment broadcastShapes

• broadcastShapes(shapes: ArrayLike<ArrayLike<number>>): ArrayLike<number>

• Broadcasts array shapes to a single shape.

  Notes

  • Two respective dimensions in two shape arrays are compatible if

    1. the dimensions are equal.
    2. one dimension is 1.

  • The function returns null if provided incompatible shapes (i.e., shapes which cannot be broadcast with one another).

  Parameters

  • shapes: ArrayLike<ArrayLike<number>>

    array shapes

  Returns ArrayLike < number >

  broadcast shape

  Example

  var shapes = [
      [ 8, 1, 6, 1 ],
      [ 7, 1, 5 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 8, 7, 6, 5 ]

  Example

  var shapes = [
      [ 5, 4 ],
      [ 1 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 5, 4 ]

  Example

  var shapes = [
      [ 5, 4 ],
      [ 4 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 5, 4 ]

  Example

  var shapes = [
      [ 15, 3, 5 ],
      [ 15, 1, 5 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 15, 3, 5 ]

  Example

  var shapes = [
      [ 15, 3, 5 ],
      [ 3, 5 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 15, 3, 5 ]

  Example

  var shapes = [
      [ 15, 3, 5 ],
      [ 3, 1 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 15, 3, 5 ]

  Example

  var shapes = [
      [ 8, 1, 1, 6, 1 ],
      [ 1, 7, 1, 5 ],
      [ 8, 4, 1, 6, 5 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 8, 4, 7, 6, 5 ]

  Example

  var shapes = [
      [ 8, 1, 1, 6, 1 ],
      [ 0 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 8, 1, 1, 6, 0 ]

  Example

  var shapes = [
      [ 8, 1, 1, 6, 1 ],
      [ 8, 0, 1, 6, 1 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 8, 0, 1, 6, 1 ]

  Example

  var shapes = [
      [ 8, 8, 1, 6, 1 ],
      [ 8, 0, 1, 6, 1 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns null

  Example

  var shapes = [
      []
  ];
  
  var out = broadcastShapes( shapes );
  // returns []

  Example

  var shapes = [
      [],
      []
  ];
  
  var out = broadcastShapes( shapes );
  // returns []

  Example

  var shapes = [];
  
  var out = broadcastShapes( shapes );
  // returns []

  Example

  var shapes = [
      [ 3, 2, 1 ],
      []
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 3, 2, 1 ]

  Example

  var shapes = [
      [],
      [ 3, 2, 1 ]
  ];
  
  var out = broadcastShapes( shapes );
  // returns [ 3, 2, 1 ]