pyarrow.compute.sort_indices¶
-
pyarrow.compute.sort_indices(input, *, memory_pool=None, options=None, sort_keys, null_placement='at_end')¶ Return the indices that would sort an array, record batch or table.
This function computes an array of indices that define a stable sort of the input array, record batch or table. By default, nNull values are considered greater than any other value and are therefore sorted at the end of the input. For floating-point types, NaNs are considered greater than any other non-null value, but smaller than null values.
The handling of nulls and NaNs can be changed in SortOptions.
- Parameters
input (Array-like or scalar-like) – Argument to compute function
memory_pool (pyarrow.MemoryPool, optional) – If not passed, will allocate memory from the default memory pool.
options (pyarrow.compute.SortOptions, optional) – Parameters altering compute function semantics.
sort_keys (optional) – Parameter for SortOptions constructor. Either options or sort_keys can be passed, but not both at the same time.
null_placement (optional) – Parameter for SortOptions constructor. Either options or null_placement can be passed, but not both at the same time.