Module functions

Module functions 

Source
Expand description

§Functions

Function on multiple expressions.

Structs§

ChainedThen
Utility struct for the when-then-otherwise expression.
ChainedWhen
Utility struct for the when-then-otherwise expression.
DatetimeArgs
Arguments used by datetime in order to produce an Expr of Datetime
DurationArgs
Arguments used by duration in order to produce an Expr of Duration
Then
Utility struct for the when-then-otherwise expression.
When
Utility struct for the when-then-otherwise expression.

Functions§

all
Selects all columns.
all_horizontal
Create a new column with the bitwise-and of the elements in each row.
any_horizontal
Create a new column with the bitwise-or of the elements in each row.
arange
Generate a range of integers.
arg_sort_byrange
Find the indexes that would sort these series in order of appearance.
arg_wherearg_where
Get the indices where condition evaluates true.
as_struct
Take several expressions and collect them into a StructChunked.
avg
Find the mean of all the values in the column named name. Alias for mean.
binary_expr
Compute op(l, r) (or equivalently l op r). l and r must have types compatible with the Operator.
business_day_countdtype-date
by_name
Select multiple columns by dtype.
cast
Casts the column given by Expr to a different type.
coalesce
Folds the expressions from left to right keeping the first non-null values.
col
Create a Column Expression based on a column name.
cols
Select multiple columns by name.
concat
Concat multiple LazyFrames vertically.
concat_arr
Horizontally concatenate columns into a single array-type column.
concat_expr
concat_lf_diagonaldiagonal_concat
Concat LazyFrames diagonally. Calls concat internally.
concat_lf_horizontal
Concat LazyFrames horizontally.
concat_list
Concat lists entries.
concat_strconcat_str and strings
Horizontally concat string columns in linear time
cov
Compute the covariance between two columns.
cum_fold_exprsdtype-struct
Accumulate over multiple columns horizontally / row wise.
cum_reduce_exprsdtype-struct
Accumulate over multiple columns horizontally / row wise.
date_rangedtype-date
Create a date range column from start, end, and interval, and expressions.
date_rangesdtype-date
Create a column of date ranges from start, end, interval, and num_samples expressions.
datetime
Construct a column of Datetime from the provided DatetimeArgs.
datetime_rangedtype-datetime
Create a datetime range from start, end, interval, and num_samples expressions.
datetime_rangesdtype-datetime
Create a column of datetime ranges from start, end, interval, and num_samples expressions.
dtype_col
Select multiple columns by dtype.
dtype_cols
Select multiple columns by dtype.
durationdtype-duration
Construct a column of Duration from the provided DurationArgs
element
empty
Selects no columns.
first
First column in a DataFrame.
fold_exprs
Accumulate over multiple columns horizontally / row wise.
format_strconcat_str and strings
Format the results of an array of expressions using a format string
index_cols
Select multiple columns by index.
int_range
Generate a range of integers.
int_ranges
Generate a range of integers for each row of the input columns.
is_not_null
A column which is false wherever expr is null, true elsewhere.
is_null
A column which is true wherever expr is null, false elsewhere.
last
Last column in a DataFrame.
len
Return the number of rows in the context.
linear_space
Generate a series of equally-spaced points.
linear_spaces
Create a column of linearly-spaced sequences from ‘start’, ‘end’, and ‘num_samples’ expressions.
lit
Create a Literal Expression from L. A literal expression behaves like a column that contains a single distinct value.
max
Find the maximum of all the values in the column named name. Shorthand for col(name).max().
max_horizontal
Create a new column with the maximum value per row.
mean
Find the mean of all the values in the column named name. Shorthand for col(name).mean().
mean_horizontal
Compute the mean of all values horizontally across columns.
median
Find the median of all the values in the column named name. Shorthand for col(name).median().
min
Find the minimum of all the values in the column named name. Shorthand for col(name).min().
min_horizontal
Create a new column with the minimum value per row.
not
Negates a boolean column.
nth
Nth column in a DataFrame.
pearson_corr
Compute the pearson correlation between two columns.
quantile
Find a specific quantile of all the values in the column named name.
reduce_exprs
Analogous to Iterator::reduce.
repeat
Create a column of length n containing n copies of the literal value.
rolling_corrrolling_window and cov
rolling_covrolling_window and cov
spearman_rank_corrrank and propagate_nans
Compute the spearman rank correlation between two columns. Missing data will be excluded from the computation.
sum
Sum all the values in the column named name. Shorthand for col(name).sum().
sum_horizontal
Sum all values horizontally across columns.
ternary_expr
time_rangedtype-time
Generate a time range.
time_rangesdtype-time
Create a column of time ranges from a start and stop expression.
when
Start a when-then-otherwise expression.