xorbits.numpy.broadcast#

xorbits.numpy.broadcast = <function broadcast>#

Produce an object that mimics broadcasting.

Parameters

  • in1 (array_like) – Input parameters.

  • in2 (array_like) – Input parameters.

  • ... (array_like) – Input parameters.

Returns

b – Broadcast the input parameters against one another, and return an object that encapsulates the result. Amongst others, it has shape and nd properties, and may be used as an iterator.

Return type

broadcast object

See also

broadcast_arrays, broadcast_to, broadcast_shapes

Examples

Manually adding two vectors, using broadcasting:

>>> x = np.array([[1], [2], [3]])  
>>> y = np.array([4, 5, 6])  
>>> b = np.broadcast(x, y)  

>>> out = np.empty(b.shape)  
>>> out.flat = [u+v for (u,v) in b]  
>>> out  
array([[5.,  6.,  7.],
       [6.,  7.,  8.],
       [7.,  8.,  9.]])

Compare against built-in broadcasting:

>>> x + y  
array([[5, 6, 7],
       [6, 7, 8],
       [7, 8, 9]])

Warning

This method has not been implemented yet. Xorbits will try to execute it with numpy.

This docstring was copied from numpy.