broadcast_arrays

Broadcasts one or more arrays against one another.

Parameters:

Name	Type	Description	Default
arrays		an arbitrary number of to-be broadcasted arrays.	()

Returns:

Name	Type	Description
out	List[array]	a list of broadcasted arrays. Each array has the same shape. Each array has the same dtype as its corresponding input array.

Examples:

>>> a = sparse.COO.from_numpy(np.array([[0, 1]]))
>>> b = sparse.COO.from_numpy(np.array([[0], [2]]))
>>> oa, ob = sparse.broadcast_arrays(a, b)
>>> oa.todense()
array([[0, 1],
        [0, 1]])
>>> ob.todense()
array([[0, 0],
        [2, 2]])

Source code in sparse/numba_backend/_common.py

def broadcast_arrays(*arrays):
    """
    Broadcasts one or more arrays against one another.

    Parameters
    ----------
    arrays: array
        an arbitrary number of to-be broadcasted arrays.

    Returns
    -------
    out: List[array]
        a list of broadcasted arrays. Each array has the same shape.
        Each array has the same dtype as its corresponding input array.

    Examples
    --------
    >>> a = sparse.COO.from_numpy(np.array([[0, 1]]))
    >>> b = sparse.COO.from_numpy(np.array([[0], [2]]))
    >>> oa, ob = sparse.broadcast_arrays(a, b)
    >>> oa.todense()  # doctest: +NORMALIZE_WHITESPACE
    array([[0, 1],
            [0, 1]])
    >>> ob.todense()  # doctest: +NORMALIZE_WHITESPACE
    array([[0, 0],
            [2, 2]])
    """

    shape = np.broadcast_shapes(*[a.shape for a in arrays])
    return [a.broadcast_to(shape) for a in arrays]