Struct polars::chunked_array::ops::sort::options::SortMultipleOptions

pub struct SortMultipleOptions {
    pub descending: Vec<bool>,
    pub nulls_last: Vec<bool>,
    pub multithreaded: bool,
    pub maintain_order: bool,
}

Sort options for multi-series sorting.

Indicating the order of sorting, nulls position, multithreading, and maintaining order.

Example

let df = df! {
    "a" => [Some(1), Some(2), None, Some(4), None],
    "b" => [Some(5), None, Some(3), Some(2), Some(1)]
}?;

let out = df
    .sort(
        ["a", "b"],
        SortMultipleOptions::default()
            .with_maintain_order(true)
            .with_multithreaded(false)
            .with_order_descending_multi([false, true])
            .with_nulls_last(true),
    )?;

let expected = df! {
    "a" => [Some(1), Some(2), Some(4), None, None],
    "b" => [Some(5), None, Some(2), Some(3), Some(1)]
}?;

assert_eq!(out, expected);

Fields

descending: Vec<bool>

Order of the columns. Default all `false``.

If only one value is given, it will broadcast to all columns.

Use SortMultipleOptions::with_order_descending_multi or SortMultipleOptions::with_order_descending to modify.

Safety

Len must match the number of columns, or equal 1.

nulls_last: Vec<bool>

Whether place null values last. Default false.

multithreaded: bool

Whether sort in multiple threads. Default true.

maintain_order: bool

Whether maintain the order of equal elements. Default false.

Implementations

impl SortMultipleOptions

pub fn new() -> SortMultipleOptions

Create SortMultipleOptions with default values.

pub fn with_order_descending_multi( self, descending: impl IntoIterator<Item = bool> ) -> SortMultipleOptions

Specify order for each column. Defaults all false.

Safety

Len must match the number of columns, or be equal to 1.

pub fn with_order_descending(self, descending: bool) -> SortMultipleOptions

Implement order for all columns. Default false.

pub fn with_nulls_last_multi( self, nulls_last: impl IntoIterator<Item = bool> ) -> SortMultipleOptions

Specify whether to place nulls last, per-column. Defaults all false.

Safety

Len must match the number of columns, or be equal to 1.

pub fn with_nulls_last(self, enabled: bool) -> SortMultipleOptions

Whether to place null values last. Default false.

pub fn with_multithreaded(self, enabled: bool) -> SortMultipleOptions

Whether to sort in multiple threads. Default true.

pub fn with_maintain_order(self, enabled: bool) -> SortMultipleOptions

Whether to maintain the order of equal elements. Default false.

pub fn with_order_reversed(self) -> SortMultipleOptions

Reverse the order of sorting for each column.

Trait Implementations

impl Clone for SortMultipleOptions

fn clone(&self) -> SortMultipleOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SortMultipleOptions

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

Formats the value using the given formatter.

impl Default for SortMultipleOptions

fn default() -> SortMultipleOptions

Returns the “default value” for a type.

impl From<&SortMultipleOptions> for SortOptions

fn from(value: &SortMultipleOptions) -> SortOptions

Converts to this type from the input type.

impl From<&SortOptions> for SortMultipleOptions

fn from(value: &SortOptions) -> SortMultipleOptions

Converts to this type from the input type.

impl Hash for SortMultipleOptions

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

where __H: Hasher,

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 SortMultipleOptions

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SortMultipleOptions

impl StructuralPartialEq for SortMultipleOptions