permute_dims

Permutes the axes (dimensions) of an array x.

Parameters:

Name	Type	Description	Default
x		input array.	required
axes		tuple containing a permutation of (0, 1, ..., N-1) where N is the number of axes (dimensions) of x.	None

Returns:

Name	Type	Description
out	array	an array containing the axes permutation. The returned array must have the same data type as x.

Examples:

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

Source code in sparse/numba_backend/_common.py

def permute_dims(x, /, axes=None):
    """
    Permutes the axes (dimensions) of an array ``x``.

    Parameters
    ----------
    x: array
        input array.
    axes: Tuple[int, ...]
        tuple containing a permutation of ``(0, 1, ..., N-1)`` where ``N`` is the number of axes (dimensions)
        of ``x``.

    Returns
    -------
    out: array
        an array containing the axes permutation. The returned array must have the same data type as ``x``.

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

    return x.transpose(axes=axes)