papyri
{ } Raw JSON

bundles / numpy 2.4.4 / numpy / argsort

_ArrayFunctionDispatcher

numpy:argsort

source: /numpy/_core/fromnumeric.py :1100

Signature

def   argsort ( a ,  axis = -1 ,  kind = None ,  order = None ,  * ,  stable = None )

Summary

Returns the indices that would sort an array.

Extended Summary

Perform an indirect sort along the given axis using the algorithm specified by the kind keyword. It returns an array of indices of the same shape as a that index data along the given axis in sorted order.

Parameters

a : array_like

Array to sort.

axis : int or None, optional

Axis along which to sort. The default is -1 (the last axis). If None, the flattened array is used.

kind : {'quicksort', 'mergesort', 'heapsort', 'stable'}, optional

Sorting algorithm. The default is 'quicksort'. Note that both 'stable' and 'mergesort' use timsort under the covers and, in general, the actual implementation will vary with data type. The 'mergesort' option is retained for backwards compatibility.

order : str or list of str, optional

When a is an array with fields defined, this argument specifies which fields to compare first, second, etc. A single field can be specified as a string, and not all fields need be specified, but unspecified fields will still be used, in the order in which they come up in the dtype, to break ties.

stable : bool, optional

Sort stability. If True, the returned array will maintain the relative order of a values which compare as equal. If False or None, this is not guaranteed. Internally, this option selects kind='stable'. Default: None.

Returns

index_array : ndarray, int

Array of indices that sort a along the specified axis. If a is one-dimensional, a[index_array] yields a sorted a. More generally, np.take_along_axis(a, index_array, axis=axis) always yields the sorted a, irrespective of dimensionality.

Notes

See sort for notes on the different sorting algorithms.

As of NumPy 1.4.0 argsort works with real/complex arrays containing nan values. The enhanced sort order is documented in sort.

Examples

One dimensional array: 
import numpy as np
x = np.array([3, 1, 2])
np.argsort(x)
✓
Two-dimensional array: 
x = np.array([[0, 3], [2, 2]])
x
✓
ind = np.argsort(x, axis=0)  # sorts along first axis (down)
ind
np.take_along_axis(x, ind, axis=0)  # same as np.sort(x, axis=0)
✓
ind = np.argsort(x, axis=1)  # sorts along last axis (across)
ind
np.take_along_axis(x, ind, axis=1)  # same as np.sort(x, axis=1)
✓
Indices of the sorted elements of a N-dimensional array: 
ind = np.unravel_index(np.argsort(x, axis=None), x.shape)
ind
x[ind]  # same as np.sort(x, axis=None)
✓
Sorting with keys: 
x = np.array([(1, 0), (0, 1)], dtype=[('x', '<i4'), ('y', '<i4')])
✓
x
✗
np.argsort(x, order=('x','y'))
✓
np.argsort(x, order=('y','x'))
✓

See also

argpartition

Indirect partial sort.

lexsort

Indirect stable sort with multiple keys.

ndarray.sort

Inplace sort.

sort

Describes sorting algorithms used.

take_along_axis

Apply index_array from argsort to an array as if by calling sort.

Aliases

  • numpy.argsort

Referenced by

This package