Trait polars::prelude::ChunkCompare

pub trait ChunkCompare<Rhs> {
    type Item;

    // Required methods
    fn equal(&self, rhs: Rhs) -> Self::Item;
    fn equal_missing(&self, rhs: Rhs) -> Self::Item;
    fn not_equal(&self, rhs: Rhs) -> Self::Item;
    fn not_equal_missing(&self, rhs: Rhs) -> Self::Item;
    fn gt(&self, rhs: Rhs) -> Self::Item;
    fn gt_eq(&self, rhs: Rhs) -> Self::Item;
    fn lt(&self, rhs: Rhs) -> Self::Item;
    fn lt_eq(&self, rhs: Rhs) -> Self::Item;
}

Expand description

Compare Series and ChunkedArray’s and get a boolean mask that can be used to filter rows.

§Example

use polars_core::prelude::*;
fn filter_all_ones(df: &DataFrame) -> PolarsResult<DataFrame> {
    let mask = df
    .column("column_a")?
    .equal(1)?;

    df.filter(&mask)
}

Required Associated Types§

type Item

Required Methods§

fn equal(&self, rhs: Rhs) -> Self::Item

Check for equality.

fn equal_missing(&self, rhs: Rhs) -> Self::Item

Check for equality where None == None.

fn not_equal(&self, rhs: Rhs) -> Self::Item

Check for inequality.

fn not_equal_missing(&self, rhs: Rhs) -> Self::Item

Check for inequality where None == None.

fn gt(&self, rhs: Rhs) -> Self::Item

Greater than comparison.

fn gt_eq(&self, rhs: Rhs) -> Self::Item

Greater than or equal comparison.

fn lt(&self, rhs: Rhs) -> Self::Item

Less than comparison.

fn lt_eq(&self, rhs: Rhs) -> Self::Item

Less than or equal comparison

Implementors§

impl ChunkCompare<&str> for ChunkedArray<StringType>

type Item = ChunkedArray<BooleanType>

impl ChunkCompare<&str> for CategoricalChunked

type Item = Result<ChunkedArray<BooleanType>, PolarsError>

impl ChunkCompare<&str> for Series

type Item = Result<ChunkedArray<BooleanType>, PolarsError>

impl ChunkCompare<&ChunkedArray<BinaryType>> for ChunkedArray<BinaryType>

type Item = ChunkedArray<BooleanType>

impl ChunkCompare<&ChunkedArray<BooleanType>> for ChunkedArray<BooleanType>

type Item = ChunkedArray<BooleanType>

impl ChunkCompare<&ChunkedArray<FixedSizeListType>> for ChunkedArray<FixedSizeListType>

Available on crate feature dtype-array only.

type Item = ChunkedArray<BooleanType>

impl ChunkCompare<&ChunkedArray<ListType>> for ChunkedArray<ListType>

type Item = ChunkedArray<BooleanType>

impl ChunkCompare<&ChunkedArray<StringType>> for ChunkedArray<StringType>

type Item = ChunkedArray<BooleanType>

impl ChunkCompare<&ChunkedArray<StringType>> for CategoricalChunked

type Item = Result<ChunkedArray<BooleanType>, PolarsError>

impl ChunkCompare<&CategoricalChunked> for CategoricalChunked

type Item = Result<ChunkedArray<BooleanType>, PolarsError>

impl ChunkCompare<&StructChunked> for StructChunked

Available on crate feature dtype-struct only.

type Item = ChunkedArray<BooleanType>

impl ChunkCompare<&Series> for Series

type Item = Result<ChunkedArray<BooleanType>, PolarsError>

impl ChunkCompare<&[u8]> for ChunkedArray<BinaryType>

type Item = ChunkedArray<BooleanType>

impl<Rhs> ChunkCompare<Rhs> for Series
where Rhs: NumericNative,

type Item = Result<ChunkedArray<BooleanType>, PolarsError>

impl<T> ChunkCompare<&ChunkedArray<T>> for ChunkedArray<T>
where T: PolarsNumericType, <T as PolarsDataType>::Array: TotalOrdKernel<Scalar = <T as PolarsNumericType>::Native>,

type Item = ChunkedArray<BooleanType>

impl<T, Rhs> ChunkCompare<Rhs> for ChunkedArray<T>
where T: PolarsNumericType, Rhs: ToPrimitive, <T as PolarsDataType>::Array: TotalOrdKernel<Scalar = <T as PolarsNumericType>::Native>,

type Item = ChunkedArray<BooleanType>