argsort(self, axis=<no value>, kind=None, order=None, endwith=True, fill_value=None)

Notes

See sort for notes on the different sorting algorithms.

Parameters

axis : int, optional

Axis along which to sort. If None, the default, the flattened array is used.

versionchanged

Previously, the default was documented to be -1, but that was in error. At some future date, the default will change to -1, as originally intended. Until then, the axis should be given explicitly when arr.ndim > 1 , to avoid a FutureWarning.

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

The sorting algorithm used.

order : list, optional

When a is an array with fields defined, this argument specifies which fields to compare first, second, etc. Not all fields need be specified.

endwith : {True, False}, optional

Whether missing values (if any) should be treated as the largest values (True) or the smallest values (False) When the array contains unmasked values at the same extremes of the datatype, the ordering of these values and the masked values is undefined.

fill_value : scalar or None, optional

Value used internally for the masked values. If fill_value is not None, it supersedes endwith .

Returns

index_array : ndarray, int

Array of indices that sort a along the specified axis. In other words, a[index_array] yields a sorted a.

Return an ndarray of indices that sort the array along the specified axis. Masked values are filled beforehand to fill_value .

See Also

lexsort

Indirect stable sort with multiple keys.

ma.MaskedArray.sort

Describes sorting algorithms used.

numpy.ndarray.sort

Inplace sort.

Examples

This example is valid syntax, but we were not able to check execution

>>> a = np.ma.array([3,2,1], mask=[False, False, True])
... a
masked_array(data=[3, 2, --],
             mask=[False, False,  True],
       fill_value=999999)

This example is valid syntax, but we were not able to check execution

>>> a.argsort()
array([1, 0, 2])

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

GitHub : /numpy/ma/core.py#5414
type: <class 'function'>
Commit: