Enum SortPrimsDescriptor 

pub enum SortPrimsDescriptor {
    Sort {
        axis: usize,
        descending: bool,
        stable: bool,
    },
    Argsort {
        axis: usize,
        descending: bool,
        stable: bool,
    },
    Topk {
        axis: usize,
        k: usize,
        largest: bool,
        sorted: bool,
    },
}

Descriptor for sort-family planning.

Examples

use tenferro_prims::SortPrimsDescriptor;

let desc = SortPrimsDescriptor::Sort {
    axis: 0,
    descending: false,
    stable: true,
};
assert!(matches!(desc, SortPrimsDescriptor::Sort { .. }));

let desc = SortPrimsDescriptor::Topk {
    axis: 0,
    k: 3,
    largest: true,
    sorted: true,
};
assert!(matches!(desc, SortPrimsDescriptor::Topk { .. }));

Variants

Sort

Sort elements along axis.

Produces both sorted values and the corresponding permutation indices.

Fields

axis: usize

Axis along which to sort.

descending: bool

If true, sort in descending order.

stable: bool

If true, use a stable sort (preserving relative order of equal elements).

Argsort

Compute the permutation that would sort elements along axis.

Returns only the index permutation (values output is left unmodified).

Fields

axis: usize

Axis along which to compute the sort permutation.

descending: bool

If true, sort in descending order.

stable: bool

If true, use a stable sort.

Topk

Select the top-k elements along axis.

Returns the k largest (or smallest) values and their indices.

Fields

axis: usize

Axis along which to select top-k.

k: usize

Number of elements to select.

largest: bool

If true, select the k largest; if false, select the k smallest.

sorted: bool

If true, the returned k elements are sorted.

Trait Implementations

impl Clone for SortPrimsDescriptor

fn clone(&self) -> SortPrimsDescriptor

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SortPrimsDescriptor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for SortPrimsDescriptor

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SortPrimsDescriptor

fn eq(&self, other: &SortPrimsDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SortPrimsDescriptor

impl StructuralPartialEq for SortPrimsDescriptor