Skip to contents

Argsort

Source: R/api.R
nv_argsort.Rd

Returns the indices that would sort the array along a dimension.

Usage

nv_argsort(operand, dim = NULL, decreasing = FALSE, stable = FALSE)

Arguments

operand

(arrayish)
Operand.

dim

(integer(1) | NULL)
Dimension along which to compute the sort permutation. If NULL (default), uses the last dimension.

decreasing

(logical(1))
If TRUE, returns indices that produce a decreasing sort. Default FALSE.

stable

(logical(1))
If TRUE, the sort is stable: indices for equal values keep their original relative order. Default FALSE.

Value

arrayish of dtype i32
Same shape as operand. For a size-0 axis, the output is an empty i32 array of the same shape (a valid empty permutation). as_array(operand)[as_array(nv_argsort(operand))] reproduces the sorted array (for 1-D inputs).

NaN handling

NaN values sort to the end (ascending) or beginning (descending), regardless of sign. +0 and -0 compare equal.

See also

nv_sort(), prim_sort().

Examples

x <- nv_array(c(3, 1, 4, 1, 5))
nv_argsort(x)
#> AnvlArray
#>  2
#>  4
#>  1
#>  3
#>  5
#> [ CPUi32{5} ]