Enum polars_lazy::dsl::function_expr::FunctionExpr

pub enum FunctionExpr {
    ArrayExpr(ArrayFunction),
    BinaryExpr(BinaryFunction),
    Categorical(CategoricalFunction),
    ListExpr(ListFunction),
    StringExpr(StringFunction),
    StructExpr(StructFunction),
    TemporalExpr(TemporalFunction),
    Boolean(BooleanFunction),
    Business(BusinessFunction),
    Abs,
    Negate,
    Hist {
        bin_count: Option<usize>,
        include_category: bool,
        include_breakpoint: bool,
    },
    NullCount,
    Pow(PowFunction),
    Hash(u64, u64, u64, u64),
    ArgWhere,
    SearchSorted(SearchSortedSide),
    Range(RangeFunction),
    Trigonometry(TrigonometricFunction),
    Atan2,
    Sign,
    FillNull,
    FillNullWithStrategy(FillNullStrategy),
    RollingExpr(RollingFunction),
    RollingExprBy(RollingFunctionBy),
    ShiftAndFill,
    Shift,
    DropNans,
    DropNulls,
    Mode,
    Skew(bool),
    Kurtosis(bool, bool),
    Reshape(Vec<i64>, NestedType),
    RepeatBy,
    ArgUnique,
    Rank {
        options: RankOptions,
        seed: Option<u64>,
    },
    Clip {
        has_min: bool,
        has_max: bool,
    },
    AsStruct,
    TopK {
        descending: bool,
    },
    TopKBy {
        descending: Vec<bool>,
    },
    CumCount {
        reverse: bool,
    },
    CumSum {
        reverse: bool,
    },
    CumProd {
        reverse: bool,
    },
    CumMin {
        reverse: bool,
    },
    CumMax {
        reverse: bool,
    },
    Reverse,
    ValueCounts {
        sort: bool,
        parallel: bool,
        name: String,
    },
    UniqueCounts,
    ApproxNUnique,
    Coalesce,
    ShrinkType,
    Diff(i64, NullBehavior),
    PctChange,
    Interpolate(InterpolationMethod),
    InterpolateBy,
    Entropy {
        base: f64,
        normalize: bool,
    },
    Log {
        base: f64,
    },
    Log1p,
    Exp,
    Unique(bool),
    Round {
        decimals: u32,
    },
    RoundSF {
        digits: i32,
    },
    Floor,
    Ceil,
    UpperBound,
    LowerBound,
    Fused(FusedOperator),
    ConcatExpr(bool),
    Correlation {
        method: CorrelationMethod,
        ddof: u8,
    },
    PeakMin,
    PeakMax,
    Cut {
        breaks: Vec<f64>,
        labels: Option<Vec<String>>,
        left_closed: bool,
        include_breaks: bool,
    },
    QCut {
        probs: Vec<f64>,
        labels: Option<Vec<String>>,
        left_closed: bool,
        allow_duplicates: bool,
        include_breaks: bool,
    },
    RLE,
    RLEID,
    ToPhysical,
    Random {
        method: RandomMethod,
        seed: Option<u64>,
    },
    SetSortedFlag(IsSorted),
    BackwardFill {
        limit: Option<u64>,
    },
    ForwardFill {
        limit: Option<u64>,
    },
    MaxHorizontal,
    MinHorizontal,
    SumHorizontal,
    MeanHorizontal,
    EwmMean {
        options: EWMOptions,
    },
    EwmMeanBy {
        half_life: Duration,
    },
    EwmStd {
        options: EWMOptions,
    },
    EwmVar {
        options: EWMOptions,
    },
    Replace {
        return_dtype: Option<DataType>,
    },
    GatherEvery {
        n: usize,
        offset: usize,
    },
    Reinterpret(bool),
    ExtendConstant,
}

Variants

ArrayExpr(ArrayFunction)

Available on crate feature dtype-array only.

BinaryExpr(BinaryFunction)

Categorical(CategoricalFunction)

Available on crate feature dtype-categorical only.

ListExpr(ListFunction)

StringExpr(StringFunction)

Available on crate feature strings only.

StructExpr(StructFunction)

Available on crate feature dtype-struct only.

TemporalExpr(TemporalFunction)

Available on crate feature temporal only.

Boolean(BooleanFunction)

Business(BusinessFunction)

Available on crate feature business only.

Abs

Available on crate feature abs only.

Negate

Hist

Available on crate feature hist only.

Fields

bin_count: Option<usize>

include_category: bool

include_breakpoint: bool

NullCount

Pow(PowFunction)

Hash(u64, u64, u64, u64)

Available on crate feature row_hash only.

ArgWhere

Available on crate feature arg_where only.

SearchSorted(SearchSortedSide)

Available on crate feature search_sorted only.

Range(RangeFunction)

Available on crate feature range only.

Trigonometry(TrigonometricFunction)

Available on crate feature trigonometry only.

Atan2

Available on crate feature trigonometry only.

Sign

Available on crate feature sign only.

FillNull

FillNullWithStrategy(FillNullStrategy)

RollingExpr(RollingFunction)

Available on crate feature rolling_window only.

RollingExprBy(RollingFunctionBy)

Available on crate feature rolling_window_by only.

ShiftAndFill

Shift

DropNans

DropNulls

Mode

Available on crate feature mode only.

Skew(bool)

Available on crate feature moment only.

Kurtosis(bool, bool)

Available on crate feature moment only.

Reshape(Vec<i64>, NestedType)

RepeatBy

Available on crate feature repeat_by only.

ArgUnique

Rank

Available on crate feature rank only.

Fields

options: RankOptions

seed: Option<u64>

Clip

Available on crate feature round_series only.

Fields

has_min: bool

has_max: bool

AsStruct

Available on crate feature dtype-struct only.

TopK

Available on crate feature top_k only.

Fields

descending: bool

TopKBy

Available on crate feature top_k only.

Fields

descending: Vec<bool>

CumCount

Available on crate feature cum_agg only.

Fields

reverse: bool

CumSum

Available on crate feature cum_agg only.

Fields

reverse: bool

CumProd

Available on crate feature cum_agg only.

Fields

reverse: bool

CumMin

Available on crate feature cum_agg only.

Fields

reverse: bool

CumMax

Available on crate feature cum_agg only.

Fields

reverse: bool

Reverse

ValueCounts

Available on crate feature dtype-struct only.

Fields

sort: bool

parallel: bool

name: String

UniqueCounts

Available on crate feature unique_counts only.

ApproxNUnique

Available on crate feature approx_unique only.

Coalesce

ShrinkType

Diff(i64, NullBehavior)

Available on crate feature diff only.

PctChange

Available on crate feature pct_change only.

Interpolate(InterpolationMethod)

Available on crate feature interpolate only.

InterpolateBy

Available on crate feature interpolate_by only.

Entropy

Available on crate feature log only.

Fields

base: f64

normalize: bool

Log

Available on crate feature log only.

Fields

base: f64

Log1p

Available on crate feature log only.

Exp

Available on crate feature log only.

Unique(bool)

Round

Available on crate feature round_series only.

Fields

decimals: u32

RoundSF

Available on crate feature round_series only.

Fields

digits: i32

Floor

Available on crate feature round_series only.

Ceil

Available on crate feature round_series only.

UpperBound

LowerBound

Fused(FusedOperator)

Available on crate feature fused only.

ConcatExpr(bool)

Correlation

Available on crate feature cov only.

Fields

method: CorrelationMethod

ddof: u8

PeakMin

Available on crate feature peaks only.

PeakMax

Available on crate feature peaks only.

Cut

Available on crate feature cutqcut only.

Fields

breaks: Vec<f64>

labels: Option<Vec<String>>

left_closed: bool

include_breaks: bool

QCut

Available on crate feature cutqcut only.

Fields

probs: Vec<f64>

labels: Option<Vec<String>>

left_closed: bool

allow_duplicates: bool

include_breaks: bool

RLE

Available on crate feature rle only.

RLEID

Available on crate feature rle only.

ToPhysical

Random

Available on crate feature random only.

Fields

method: RandomMethod

seed: Option<u64>

SetSortedFlag(IsSorted)

BackwardFill

Fields

limit: Option<u64>

ForwardFill

Fields

limit: Option<u64>

MaxHorizontal

MinHorizontal

SumHorizontal

MeanHorizontal

EwmMean

Available on crate feature ewma only.

Fields

options: EWMOptions

EwmMeanBy

Available on crate feature ewma_by only.

Fields

half_life: Duration

EwmStd

Available on crate feature ewma only.

Fields

options: EWMOptions

EwmVar

Available on crate feature ewma only.

Fields

options: EWMOptions

Replace

Available on crate feature replace only.

Fields

return_dtype: Option<DataType>

GatherEvery

Fields

n: usize

offset: usize

Reinterpret(bool)

Available on crate feature reinterpret only.

ExtendConstant

Trait Implementations

impl Clone for FunctionExpr

fn clone(&self) -> FunctionExpr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionExpr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionExpr

fn deserialize<__D>( __deserializer: __D ) -> Result<FunctionExpr, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FunctionExpr

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

Formats the value using the given formatter.

impl From<BinaryFunction> for FunctionExpr

fn from(b: BinaryFunction) -> FunctionExpr

Converts to this type from the input type.

impl From<BooleanFunction> for FunctionExpr

fn from(func: BooleanFunction) -> FunctionExpr

Converts to this type from the input type.

impl From<CategoricalFunction> for FunctionExpr

fn from(func: CategoricalFunction) -> FunctionExpr

Converts to this type from the input type.

impl From<FunctionExpr> for SpecialEq<Arc<dyn SeriesUdf>>

fn from(func: FunctionExpr) -> SpecialEq<Arc<dyn SeriesUdf>>

Converts to this type from the input type.

impl From<StringFunction> for FunctionExpr

fn from(str: StringFunction) -> FunctionExpr

Converts to this type from the input type.

impl Hash for FunctionExpr

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 FunctionExpr

fn eq(&self, other: &FunctionExpr) -> 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 Serialize for FunctionExpr

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionExpr