sort

Returns a sorted copy of an input array x.

Parameters:

Name	Type	Description	Default
x	SparseArray	Input array. Should have a real-valued data type.	required
axis	int	Axis along which to sort. If set to -1, the function must sort along the last axis. Default: -1.	-1
descending	bool_	Sort order. If True, the array must be sorted in descending order (by value). If False, the array must be sorted in ascending order (by value). Default: False.	False
stable	bool_	Whether the sort is stable. Only False is supported currently.	False

Returns:

Name	Type	Description
out	COO	A sorted array.

Raises:

Type	Description
ValueError	If the input array isn't and can't be converted to COO format.

Examples:

>>> import sparse
>>> x = sparse.COO.from_numpy([1, 0, 2, 0, 2, -3])
>>> sparse.sort(x).todense()
array([-3,  0,  0,  1,  2,  2])
>>> sparse.sort(x, descending=True).todense()
array([ 2,  2,  1,  0,  0, -3])

Source code in sparse/numba_backend/_coo/common.py

def sort(x, /, *, axis=-1, descending=False, stable=False):
    """
    Returns a sorted copy of an input array ``x``.

    Parameters
    ----------
    x : SparseArray
        Input array. Should have a real-valued data type.
    axis : int
        Axis along which to sort. If set to ``-1``, the function must sort along
        the last axis. Default: ``-1``.
    descending : bool
        Sort order. If ``True``, the array must be sorted in descending order (by value).
        If ``False``, the array must be sorted in ascending order (by value).
        Default: ``False``.
    stable : bool
        Whether the sort is stable. Only ``False`` is supported currently.

    Returns
    -------
    out : COO
        A sorted array.

    Raises
    ------
    ValueError
        If the input array isn't and can't be converted to COO format.

    Examples
    --------
    >>> import sparse
    >>> x = sparse.COO.from_numpy([1, 0, 2, 0, 2, -3])
    >>> sparse.sort(x).todense()
    array([-3,  0,  0,  1,  2,  2])
    >>> sparse.sort(x, descending=True).todense()
    array([ 2,  2,  1,  0,  0, -3])

    """
    from .._common import moveaxis
    from .core import COO

    x = _validate_coo_input(x)

    if stable:
        raise ValueError("`stable=True` isn't currently supported.")

    original_ndim = x.ndim
    if x.ndim == 1:
        x = x[None, :]
        axis = -1

    x = moveaxis(x, source=axis, destination=-1)
    x_shape = x.shape
    x = x.reshape((-1, x_shape[-1]))

    new_coords, new_data = _sort_coo(x.coords, x.data, x.fill_value, sort_axis_len=x_shape[-1], descending=descending)

    x = COO(new_coords, new_data, x.shape, has_duplicates=False, sorted=True, fill_value=x.fill_value)

    x = x.reshape(x_shape[:-1] + (x_shape[-1],))
    x = moveaxis(x, source=-1, destination=axis)
    if original_ndim == x.ndim:
        return x
    x = x.squeeze()
    if x.shape == ():
        return x[None]
    return x