broadcast_to

Broadcasts an array to a specified shape.

Parameters:

Name	Type	Description	Default
x		array to broadcast.	required
shape		array shape. Must be compatible with x. If the array is incompatible with the specified shape, the function raises an exception.	required

Returns:

Name	Type	Description
out	array	an array having a specified shape and having the same data type as x.

Examples:

>>> a = sparse.COO.from_numpy(np.array([[0, 1], [2, 0]]))
>>> o = sparse.broadcast_to(a, shape=(1, 2, 2))
>>> o.todense()
array([[[0, 1],
        [2, 0]]])

Source code in sparse/numba_backend/_common.py

@_support_numpy
def broadcast_to(x, /, shape):
    """
    Broadcasts an array to a specified shape.

    Parameters
    ----------
    x: array
        array to broadcast.
    shape: Tuple[int, ...]
        array shape. Must be compatible with ``x``.
        If the array is incompatible with the specified shape, the function raises an exception.

    Returns
    -------
    out: array
        an array having a specified shape and having the same data type as ``x``.

    Examples
    --------
    >>> a = sparse.COO.from_numpy(np.array([[0, 1], [2, 0]]))
    >>> o = sparse.broadcast_to(a, shape=(1, 2, 2))
    >>> o.todense()  # doctest: +NORMALIZE_WHITESPACE
    array([[[0, 1],
            [2, 0]]])
    """
    return x.broadcast_to(shape)