Enum polars_plan::dsl::FunctionExpr

pub enum FunctionExpr {
    ArrayExpr(ArrayFunction),
    BinaryExpr(BinaryFunction),
    Categorical(CategoricalFunction),
    ListExpr(ListFunction),
    StringExpr(StringFunction),
    StructExpr(StructFunction),
    TemporalExpr(TemporalFunction),
    Boolean(BooleanFunction),
    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),
    DateOffset,
    Trigonometry(TrigonometricFunction),
    Atan2,
    Sign,
    FillNull {
        super_type: DataType,
    },
    FillNullWithStrategy(FillNullStrategy),
    RollingExpr(RollingFunction),
    ShiftAndFill,
    Shift,
    DropNans,
    DropNulls,
    Mode,
    Skew(bool),
    Kurtosis(bool, bool),
    Reshape(Vec<i64>),
    RepeatBy,
    ArgUnique,
    Rank {
        options: RankOptions,
        seed: Option<u64>,
    },
    Clip {
        has_min: bool,
        has_max: bool,
    },
    AsStruct,
    TopK(bool),
    CumCount {
        reverse: bool,
    },
    CumSum {
        reverse: bool,
    },
    CumProd {
        reverse: bool,
    },
    CumMin {
        reverse: bool,
    },
    CumMax {
        reverse: bool,
    },
    Reverse,
    ValueCounts {
        sort: bool,
        parallel: bool,
    },
    UniqueCounts,
    ApproxNUnique,
    Coalesce,
    ShrinkType,
    Diff(i64, NullBehavior),
    PctChange,
    Interpolate(InterpolationMethod),
    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: FillNullLimit,
    },
    ForwardFill {
        limit: FillNullLimit,
    },
    MaxHorizontal,
    MinHorizontal,
    SumHorizontal,
    MeanHorizontal,
    EwmMean {
        options: EWMOptions,
    },
    EwmStd {
        options: EWMOptions,
    },
    EwmVar {
        options: EWMOptions,
    },
    Replace {
        return_dtype: Option<DataType>,
    },
    GatherEvery {
        n: usize,
        offset: usize,
    },
    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)

Abs

Available on crate feature abs only.

Negate

Hist

Fields

bin_count: Option<usize>

include_category: bool

include_breakpoint: bool

Available on crate feature hist only.

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.

DateOffset

Available on crate feature date_offset only.

Trigonometry(TrigonometricFunction)

Available on crate feature trigonometry only.

Atan2

Available on crate feature trigonometry only.

Sign

Available on crate feature sign only.

FillNull

Fields

super_type: DataType

FillNullWithStrategy(FillNullStrategy)

RollingExpr(RollingFunction)

Available on crate feature rolling_window 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>)

RepeatBy

Available on crate feature repeat_by only.

ArgUnique

Rank

Fields

options: RankOptions

seed: Option<u64>

Available on crate feature rank only.

Clip

Fields

has_min: bool

has_max: bool

Available on crate feature round_series only.

AsStruct

Available on crate feature dtype-struct only.

TopK(bool)

Available on crate feature top_k only.

CumCount

Fields

reverse: bool

Available on crate feature cum_agg only.

CumSum

Fields

reverse: bool

Available on crate feature cum_agg only.

CumProd

Fields

reverse: bool

Available on crate feature cum_agg only.

CumMin

Fields

reverse: bool

Available on crate feature cum_agg only.

CumMax

Fields

reverse: bool

Available on crate feature cum_agg only.

Reverse

ValueCounts

Fields

sort: bool

parallel: bool

Available on crate feature dtype-struct only.

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.

Entropy

Fields

base: f64

normalize: bool

Available on crate feature log only.

Log

Fields

base: f64

Available on crate feature log only.

Log1p

Available on crate feature log only.

Exp

Available on crate feature log only.

Unique(bool)

Round

Fields

decimals: u32

Available on crate feature round_series only.

RoundSF

Fields

digits: i32

Available on crate feature round_series only.

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

Fields

method: CorrelationMethod

ddof: u8

Available on crate feature cov only.

PeakMin

Available on crate feature peaks only.

PeakMax

Available on crate feature peaks only.

Cut

Fields

breaks: Vec<f64>

labels: Option<Vec<String>>

left_closed: bool

include_breaks: bool

Available on crate feature cutqcut only.

QCut

Fields

probs: Vec<f64>

labels: Option<Vec<String>>

left_closed: bool

allow_duplicates: bool

include_breaks: bool

Available on crate feature cutqcut only.

RLE

Available on crate feature rle only.

RLEID

Available on crate feature rle only.

ToPhysical

Random

Fields

method: RandomMethod

seed: Option<u64>

Available on crate feature random only.

SetSortedFlag(IsSorted)

BackwardFill

Fields

limit: FillNullLimit

ForwardFill

Fields

limit: FillNullLimit

MaxHorizontal

MinHorizontal

SumHorizontal

MeanHorizontal

EwmMean

Fields

options: EWMOptions

Available on crate feature ewma only.

EwmStd

Fields

options: EWMOptions

Available on crate feature ewma only.

EwmVar

Fields

options: EWMOptions

Available on crate feature ewma only.

Replace

Fields

return_dtype: Option<DataType>

Available on crate feature replace only.

GatherEvery

Fields

n: usize

offset: usize

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FunctionExpr

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

Formats the value using the given formatter.

impl From<BooleanFunction> for FunctionExpr

fn from(func: BooleanFunction) -> Self

Converts to this type from the input type.

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

fn from(func: FunctionExpr) -> Self

Converts to this type from the input type.

impl Hash for FunctionExpr

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

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionExpr