Trait polars::chunked_array::object::ChunkSort

pub trait ChunkSort<T> {
    fn sort(&self, reverse: bool) -> ChunkedArray<T>;
    fn sort_in_place(&mut self, reverse: bool);
    fn argsort(&self, reverse: bool) -> ChunkedArray<UInt32Type>;

    fn argsort_multiple(
        &self, 
        _other: &[Series], 
        _reverse: &[bool]
    ) -> Result<ChunkedArray<UInt32Type>, PolarsError> { ... }
}

Sort operations on ChunkedArray.

Required methods

fn sort(&self, reverse: bool) -> ChunkedArray<T>

Returned a sorted ChunkedArray.

fn sort_in_place(&mut self, reverse: bool)

Sort this array in place.

fn argsort(&self, reverse: bool) -> ChunkedArray<UInt32Type>

Retrieve the indexes needed to sort this array.

Provided methods

fn argsort_multiple(
    &self,
    _other: &[Series],
    _reverse: &[bool]
) -> Result<ChunkedArray<UInt32Type>, PolarsError>

Retrieve the indexes need to sort this and the other arrays.

Implementors

impl ChunkSort<BooleanType> for ChunkedArray<BooleanType>

pub fn sort(&self, reverse: bool) -> ChunkedArray<BooleanType>

pub fn sort_in_place(&mut self, reverse: bool)

pub fn argsort(&self, reverse: bool) -> ChunkedArray<UInt32Type>

impl ChunkSort<CategoricalType> for ChunkedArray<CategoricalType>

pub fn sort(&self, reverse: bool) -> ChunkedArray<CategoricalType>

pub fn sort_in_place(&mut self, reverse: bool)

pub fn argsort(&self, reverse: bool) -> ChunkedArray<UInt32Type>

impl ChunkSort<ListType> for ChunkedArray<ListType>

pub fn sort(&self, _reverse: bool) -> ChunkedArray<ListType>

pub fn sort_in_place(&mut self, _reverse: bool)

pub fn argsort(&self, _reverse: bool) -> ChunkedArray<UInt32Type>

impl ChunkSort<Utf8Type> for ChunkedArray<Utf8Type>

pub fn argsort_multiple(
    &self,
    other: &[Series],
    reverse: &[bool]
) -> Result<ChunkedArray<UInt32Type>, PolarsError>

Panics

This function is very opinionated. On the implementation of ChunkedArray<T> for numeric types, we assume that all numeric Series are of the same type.

In this case we assume that all numeric Series are f64 types. The caller needs to uphold this contract. If not, it will panic.

pub fn sort(&self, reverse: bool) -> ChunkedArray<Utf8Type>

pub fn sort_in_place(&mut self, reverse: bool)

pub fn argsort(&self, reverse: bool) -> ChunkedArray<UInt32Type>

impl<T> ChunkSort<ObjectType<T>> for ChunkedArray<ObjectType<T>>

pub fn sort(&self, _reverse: bool) -> ChunkedArray<ObjectType<T>>

pub fn sort_in_place(&mut self, _reverse: bool)

pub fn argsort(&self, _reverse: bool) -> ChunkedArray<UInt32Type>

impl<T> ChunkSort<T> for ChunkedArray<T> where
    T: PolarsNumericType,
    <T as ArrowPrimitiveType>::Native: PartialOrd<<T as ArrowPrimitiveType>::Native>, 

pub fn argsort_multiple(
    &self,
    other: &[Series],
    reverse: &[bool]
) -> Result<ChunkedArray<UInt32Type>, PolarsError>

Panics

This function is very opinionated. We assume that all numeric Series are of the same type, if not it will panic

pub fn sort(&self, reverse: bool) -> ChunkedArray<T>

pub fn sort_in_place(&mut self, reverse: bool)

pub fn argsort(&self, reverse: bool) -> ChunkedArray<UInt32Type>