arkouda.array_api.sorting_functions

Functions

argsort(→ arkouda.array_api.array_object.Array)	Return the indices that sort an array along a specified axis.
sort(→ arkouda.array_api.array_object.Array)	Return a sorted copy of an array along a specified axis.

Module Contents

arkouda.array_api.sorting_functions.argsort(x: arkouda.array_api.array_object.Array, /, *, axis: int = -1, descending: bool = False, stable: bool = True) → arkouda.array_api.array_object.Array

Return the indices that sort an array along a specified axis.

Parameters:

• x (Array) – The array to sort

• axis (int, optional) – The axis along which to sort.

• descending (bool, optional) – Whether to sort in descending order.

• stable (bool, optional) – Whether to use a stable sorting algorithm. Note: arkouda’s sorting algorithm is always stable so this argument is ignored.

arkouda.array_api.sorting_functions.sort(x: arkouda.array_api.array_object.Array, /, *, axis: int = -1, descending: bool = False, stable: bool = True) → arkouda.array_api.array_object.Array

Return a sorted copy of an array along a specified axis.

Parameters:

• x (Array) – The array to sort

• axis (int, optional) – The axis along which to sort.

• descending (bool, optional) – Whether to sort in descending order.

• stable (bool, optional) – Whether to use a stable sorting algorithm. Note: arkouda’s sorting algorithm is always stable so this argument is ignored.