argsort¶
- argsort(x: array, /, *, axis: int = -1, descending: bool = False, stable: bool = True) array ¶
Returns the indices that sort an array
x
along a specified axis.Note
For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see Complex Number Ordering).
- Parameters:
x (array) – 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 returned indices sortx
in descending order (by value). IfFalse
, the returned indices sortx
in ascending order (by value). Default:False
.stable (bool) – sort stability. If
True
, the returned indices must maintain the relative order ofx
values which compare as equal. IfFalse
, the returned indices may or may not maintain the relative order ofx
values which compare as equal (i.e., the relative order ofx
values which compare as equal is implementation-dependent). Default:True
.
- Returns:
out (array) – an array of indices. The returned array must have the same shape as
x
. The returned array must have the default array index data type.