Struct polars::chunked_array::ops::SortMultipleOptions

source ·
pub struct SortMultipleOptions {
    pub descending: Vec<bool>,
    pub nulls_last: Vec<bool>,
    pub multithreaded: bool,
    pub maintain_order: bool,
}
Expand description

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§

source§

impl SortMultipleOptions

source

pub fn new() -> SortMultipleOptions

Create SortMultipleOptions with default values.

source

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.

source

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

Implement order for all columns. Default false.

source

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.

source

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

Whether to place null values last. Default false.

source

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

Whether to sort in multiple threads. Default true.

source

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

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

source

pub fn with_order_reversed(self) -> SortMultipleOptions

Reverse the order of sorting for each column.

Trait Implementations§

source§

impl Clone for SortMultipleOptions

source§

fn clone(&self) -> SortMultipleOptions

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SortMultipleOptions

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for SortMultipleOptions

source§

fn default() -> SortMultipleOptions

Returns the “default value” for a type. Read more
source§

impl From<&SortMultipleOptions> for SortOptions

source§

fn from(value: &SortMultipleOptions) -> SortOptions

Converts to this type from the input type.
source§

impl From<&SortOptions> for SortMultipleOptions

source§

fn from(value: &SortOptions) -> SortMultipleOptions

Converts to this type from the input type.
source§

impl Hash for SortMultipleOptions

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for SortMultipleOptions

source§

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

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

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.
source§

impl Eq for SortMultipleOptions

source§

impl StructuralPartialEq for SortMultipleOptions

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V