FunctionExpr

polars_lazy::dsl

Enum FunctionExpr 

pub enum FunctionExpr {

Show 106 variants    ArrayExpr(ArrayFunction),
    BinaryExpr(BinaryFunction),
    Categorical(CategoricalFunction),
    Extension(ExtensionFunction),
    ListExpr(ListFunction),
    StringExpr(StringFunction),
    StructExpr(StructFunction),
    TemporalExpr(TemporalFunction),
    Bitwise(BitwiseFunction),
    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,
    IndexOf,
    SearchSorted {
        side: SearchSortedSide,
        descending: bool,
    },
    Range(RangeFunction),
    Trigonometry(TrigonometricFunction),
    Atan2,
    Sign,
    FillNull,
    FillNullWithStrategy(FillNullStrategy),
    RollingExpr {
        function: RollingFunction,
        options: RollingOptionsFixedWindow,
    },
    RollingExprBy {
        function_by: RollingFunctionBy,
        options: RollingOptionsDynamicWindow,
    },
    Rechunk,
    Append {
        upcast: bool,
    },
    ShiftAndFill,
    Shift,
    DropNans,
    DropNulls,
    Mode {
        maintain_order: bool,
    },
    Skew(bool),
    Kurtosis(bool, bool),
    Reshape(Vec<ReshapeDimension>),
    RepeatBy,
    ArgUnique,
    ArgMin,
    ArgMax,
    ArgSort {
        descending: bool,
        nulls_last: bool,
    },
    Product,
    Rank {
        options: RankOptions,
        seed: Option<u64>,
    },
    Repeat,
    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: PlSmallStr,
        normalize: bool,
    },
    UniqueCounts,
    ApproxNUnique,
    Coalesce,
    Diff(NullBehavior),
    PctChange,
    Interpolate(InterpolationMethod),
    InterpolateBy,
    Entropy {
        base: f64,
        normalize: bool,
    },
    Log,
    Log1p,
    Exp,
    Unique(bool),
    Round {
        decimals: u32,
        mode: RoundMode,
    },
    RoundSF {
        digits: i32,
    },
    Floor,
    Ceil,
    UpperBound,
    LowerBound,
    ConcatExpr(bool),
    Correlation {
        method: CorrelationMethod,
    },
    PeakMin,
    PeakMax,
    Cut {
        breaks: Vec<f64>,
        labels: Option<Vec<PlSmallStr>>,
        left_closed: bool,
        include_breaks: bool,
    },
    QCut {
        probs: Vec<f64>,
        labels: Option<Vec<PlSmallStr>>,
        left_closed: bool,
        allow_duplicates: bool,
        include_breaks: bool,
    },
    RLE,
    RLEID,
    ToPhysical,
    Random {
        method: RandomMethod,
        seed: Option<u64>,
    },
    SetSortedFlag(IsSorted),
    FfiPlugin {
        flags: FunctionOptions,
        lib: PlSmallStr,
        symbol: PlSmallStr,
        kwargs: Arc<[u8]>,
    },
    FoldHorizontal {
        callback: PlanCallback<(Series, Series), Series>,
        returns_scalar: bool,
        return_dtype: Option<DataTypeExpr>,
    },
    ReduceHorizontal {
        callback: PlanCallback<(Series, Series), Series>,
        returns_scalar: bool,
        return_dtype: Option<DataTypeExpr>,
    },
    CumReduceHorizontal {
        callback: PlanCallback<(Series, Series), Series>,
        returns_scalar: bool,
        return_dtype: Option<DataTypeExpr>,
    },
    CumFoldHorizontal {
        callback: PlanCallback<(Series, Series), Series>,
        returns_scalar: bool,
        return_dtype: Option<DataTypeExpr>,
        include_init: bool,
    },
    MaxHorizontal,
    MinHorizontal,
    SumHorizontal {
        ignore_nulls: bool,
    },
    MeanHorizontal {
        ignore_nulls: bool,
    },
    EwmMean {
        options: EWMOptions,
    },
    EwmMeanBy {
        half_life: Duration,
    },
    EwmStd {
        options: EWMOptions,
    },
    EwmVar {
        options: EWMOptions,
    },
    Replace,
    ReplaceStrict {
        return_dtype: Option<DataTypeExpr>,
    },
    GatherEvery {
        n: usize,
        offset: usize,
    },
    Reinterpret(bool),
    ExtendConstant,
    RowEncode(RowEncodingVariant),
    RowDecode(Vec<(PlSmallStr, DataTypeExpr)>, RowEncodingVariant),

}

Variants§

§

ArrayExpr(ArrayFunction)

Available on crate feature dtype-array only.
§

BinaryExpr(BinaryFunction)

§

Categorical(CategoricalFunction)

Available on crate feature dtype-categorical only.
§

Extension(ExtensionFunction)

Available on crate feature dtype-extension 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.
§

Bitwise(BitwiseFunction)

Available on crate feature bitwise 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.
§

IndexOf

Available on crate feature index_of only.
§

SearchSorted

Available on crate feature search_sorted only.

Fields

§side: SearchSortedSide
§descending: bool
§

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

Available on crate feature rolling_window only.
§

RollingExprBy

Available on crate feature rolling_window_by only.
§

Rechunk

§

Append

Fields

§upcast: bool
§

ShiftAndFill

§

Shift

§

DropNans

§

DropNulls

§

Mode

Available on crate feature mode only.

Fields

§maintain_order: bool
§

Skew(bool)

Available on crate feature moment only.
§

Kurtosis(bool, bool)

Available on crate feature moment only.
§

Reshape(Vec<ReshapeDimension>)

Available on crate feature dtype-array only.
§

RepeatBy

Available on crate feature repeat_by only.
§

ArgUnique

§

ArgMin

§

ArgMax

§

ArgSort

Fields

§descending: bool
§nulls_last: bool
§

Product

§

Rank

Available on crate feature rank only.

Fields

§options: RankOptions
§seed: Option<u64>
§

Repeat

§

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: PlSmallStr
§normalize: bool
§

UniqueCounts

Available on crate feature unique_counts only.
§

ApproxNUnique

Available on crate feature approx_unique only.
§

Coalesce

§

Diff(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.
§

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
§mode: RoundMode
§

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

§

ConcatExpr(bool)

§

Correlation

Available on crate feature cov only.

Fields

§method: CorrelationMethod
§

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<PlSmallStr>>
§left_closed: bool
§include_breaks: bool
§

QCut

Available on crate feature cutqcut only.

Fields

§probs: Vec<f64>
§labels: Option<Vec<PlSmallStr>>
§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)

§

FfiPlugin

Available on crate feature ffi_plugin only.

Creating this node is unsafe This will lead to calls over FFI.

Fields

§flags: FunctionOptions
§lib: PlSmallStr

Shared library.

§symbol: PlSmallStr

Identifier in the shared lib.

§kwargs: Arc<[u8]>

Pickle serialized keyword arguments.

§

FoldHorizontal

Fields

§callback: PlanCallback<(Series, Series), Series>
§returns_scalar: bool
§return_dtype: Option<DataTypeExpr>
§

ReduceHorizontal

Fields

§callback: PlanCallback<(Series, Series), Series>
§returns_scalar: bool
§return_dtype: Option<DataTypeExpr>
§

CumReduceHorizontal

Available on crate feature dtype-struct only.

Fields

§callback: PlanCallback<(Series, Series), Series>
§returns_scalar: bool
§return_dtype: Option<DataTypeExpr>
§

CumFoldHorizontal

Available on crate feature dtype-struct only.

Fields

§callback: PlanCallback<(Series, Series), Series>
§returns_scalar: bool
§return_dtype: Option<DataTypeExpr>
§include_init: bool
§

MaxHorizontal

§

MinHorizontal

§

SumHorizontal

Fields

§ignore_nulls: bool
§

MeanHorizontal

Fields

§ignore_nulls: bool
§

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

ReplaceStrict

Available on crate feature replace only.

Fields

§return_dtype: Option<DataTypeExpr>
§

GatherEvery

Fields

§n: usize
§offset: usize
§

Reinterpret(bool)

Available on crate feature reinterpret only.
§

ExtendConstant

§

RowEncode(RowEncodingVariant)

§

RowDecode(Vec<(PlSmallStr, DataTypeExpr)>, RowEncodingVariant)

Available on crate feature dtype-struct only.

Trait Implementations§

§

impl Clone for FunctionExpr

§

fn clone(&self) -> FunctionExpr

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for FunctionExpr

§

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

Formats the value using the given formatter. Read more
§

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. Read more
§

impl Display for FunctionExpr

§

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

Formats the value using the given formatter. Read more
§

impl From<ArrayFunction> for FunctionExpr

§

fn from(value: ArrayFunction) -> FunctionExpr

Converts to this type from the input type.
§

impl From<BooleanFunction> for FunctionExpr

§

fn from(value: 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<ExtensionFunction> for FunctionExpr

§

fn from(func: ExtensionFunction) -> FunctionExpr

Converts to this type from the input type.
§

impl From<ListFunction> for FunctionExpr

§

fn from(value: ListFunction) -> FunctionExpr

Converts to this type from the input type.
§

impl From<PowFunction> for FunctionExpr

§

fn from(value: PowFunction) -> FunctionExpr

Converts to this type from the input type.
§

impl From<RangeFunction> for FunctionExpr

§

fn from(value: RangeFunction) -> FunctionExpr

Converts to this type from the input type.
§

impl From<StringFunction> for FunctionExpr

§

fn from(value: StringFunction) -> FunctionExpr

Converts to this type from the input type.
§

impl From<TrigonometricFunction> for FunctionExpr

§

fn from(value: TrigonometricFunction) -> 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. 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
§

impl PartialEq for FunctionExpr

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

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. Read more
§

impl StructuralPartialEq for FunctionExpr

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

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

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
Source§

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

Source§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
Source§

fn size(&self) -> usize

The size of the key in bytes.
Source§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
Source§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
Source§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. 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
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> ToCompactString for T
where T: Display,

§

fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>

Fallible version of [ToCompactString::to_compact_string()] Read more
§

fn to_compact_string(&self) -> CompactString

Converts the given value to a [CompactString]. Read more
Source§

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

Source§

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> ToStringFallible for T
where T: Display,

§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

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

Source§

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>,

Source§

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

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Ungil for T
where T: Send,