Enum Column

pub enum Column {
    Series(Series),
    Scalar(ScalarColumn),
}

A column within a DataFrame.

This is lazily initialized to a Series with methods like as_materialized_series and take_materialized_series.

Currently, there are two ways to represent a Column.

1. A Series of values
2. A ScalarColumn that repeats a single Scalar

Variants

Series(Series)

Scalar(ScalarColumn)

Implementations

impl Column

pub fn new<T, Phantom>(name: PlSmallStr, values: T) -> Self

where Phantom: ?Sized, Series: NamedFrom<T, Phantom>,

pub fn new_empty(name: PlSmallStr, dtype: &DataType) -> Self

pub fn new_scalar(name: PlSmallStr, scalar: Scalar, length: usize) -> Self

pub fn as_materialized_series(&self) -> &Series

Get a reference to a Series for this Column

This may need to materialize the Series on the first invocation for a specific column.

pub fn into_materialized_series(&mut self) -> &mut Series

Turn Column into a Column::Series.

This may need to materialize the Series on the first invocation for a specific column.

pub fn take_materialized_series(self) -> Series

Take Series from a Column

This may need to materialize the Series on the first invocation for a specific column.

pub fn dtype(&self) -> &DataType

pub fn field(&self) -> Cow<'_, Field>

pub fn name(&self) -> &PlSmallStr

pub fn len(&self) -> usize

pub fn with_name(self, name: PlSmallStr) -> Column

pub fn rename(&mut self, name: PlSmallStr)

pub fn as_series(&self) -> Option<&Series>

pub fn as_scalar_column(&self) -> Option<&ScalarColumn>

pub fn try_bool(&self) -> Option<&BooleanChunked>

pub fn try_i8(&self) -> Option<&Int8Chunked>

pub fn try_i16(&self) -> Option<&Int16Chunked>

pub fn try_i32(&self) -> Option<&Int32Chunked>

pub fn try_i64(&self) -> Option<&Int64Chunked>

pub fn try_u8(&self) -> Option<&UInt8Chunked>

pub fn try_u16(&self) -> Option<&UInt16Chunked>

pub fn try_u32(&self) -> Option<&UInt32Chunked>

pub fn try_u64(&self) -> Option<&UInt64Chunked>

pub fn try_f32(&self) -> Option<&Float32Chunked>

pub fn try_f64(&self) -> Option<&Float64Chunked>

pub fn try_str(&self) -> Option<&StringChunked>

pub fn try_list(&self) -> Option<&ListChunked>

pub fn try_binary(&self) -> Option<&BinaryChunked>

pub fn try_idx(&self) -> Option<&IdxCa>

pub fn try_binary_offset(&self) -> Option<&BinaryOffsetChunked>

pub fn try_decimal(&self) -> Option<&DecimalChunked>

Available on crate feature dtype-decimal only.

pub fn try_categorical(&self) -> Option<&CategoricalChunked>

Available on crate feature dtype-categorical only.

pub fn bool(&self) -> PolarsResult<&BooleanChunked>

pub fn i8(&self) -> PolarsResult<&Int8Chunked>

pub fn i16(&self) -> PolarsResult<&Int16Chunked>

pub fn i32(&self) -> PolarsResult<&Int32Chunked>

pub fn i64(&self) -> PolarsResult<&Int64Chunked>

pub fn u8(&self) -> PolarsResult<&UInt8Chunked>

pub fn u16(&self) -> PolarsResult<&UInt16Chunked>

pub fn u32(&self) -> PolarsResult<&UInt32Chunked>

pub fn u64(&self) -> PolarsResult<&UInt64Chunked>

pub fn f32(&self) -> PolarsResult<&Float32Chunked>

pub fn f64(&self) -> PolarsResult<&Float64Chunked>

pub fn str(&self) -> PolarsResult<&StringChunked>

pub fn list(&self) -> PolarsResult<&ListChunked>

pub fn binary(&self) -> PolarsResult<&BinaryChunked>

pub fn idx(&self) -> PolarsResult<&IdxCa>

pub fn binary_offset(&self) -> PolarsResult<&BinaryOffsetChunked>

pub fn decimal(&self) -> PolarsResult<&DecimalChunked>

Available on crate feature dtype-decimal only.

pub fn categorical(&self) -> PolarsResult<&CategoricalChunked>

Available on crate feature dtype-categorical only.

pub fn cast_with_options( &self, dtype: &DataType, options: CastOptions, ) -> PolarsResult<Self>

pub fn strict_cast(&self, dtype: &DataType) -> PolarsResult<Self>

pub fn cast(&self, dtype: &DataType) -> PolarsResult<Column>

pub unsafe fn cast_unchecked(&self, dtype: &DataType) -> PolarsResult<Column>

Safety

This can lead to invalid memory access in downstream code.

pub fn clear(&self) -> Self

pub fn shrink_to_fit(&mut self)

pub fn new_from_index(&self, index: usize, length: usize) -> Self

pub fn has_nulls(&self) -> bool

pub fn is_null(&self) -> BooleanChunked

pub fn is_not_null(&self) -> BooleanChunked

pub fn to_physical_repr(&self) -> Column

pub fn head(&self, length: Option<usize>) -> Column

pub fn tail(&self, length: Option<usize>) -> Column

pub fn slice(&self, offset: i64, length: usize) -> Column

pub fn split_at(&self, offset: i64) -> (Column, Column)

pub fn null_count(&self) -> usize

pub fn take(&self, indices: &IdxCa) -> PolarsResult<Column>

pub fn take_slice(&self, indices: &[IdxSize]) -> PolarsResult<Column>

pub unsafe fn take_unchecked(&self, indices: &IdxCa) -> Column

Safety

No bounds on the indexes are performed.

pub unsafe fn take_slice_unchecked(&self, indices: &[IdxSize]) -> Column

Safety

No bounds on the indexes are performed.

pub unsafe fn agg_min(&self, groups: &GroupsProxy) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub unsafe fn agg_max(&self, groups: &GroupsProxy) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub unsafe fn agg_mean(&self, groups: &GroupsProxy) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub unsafe fn agg_sum(&self, groups: &GroupsProxy) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub unsafe fn agg_first(&self, groups: &GroupsProxy) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub unsafe fn agg_last(&self, groups: &GroupsProxy) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub unsafe fn agg_n_unique(&self, groups: &GroupsProxy) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub unsafe fn agg_quantile( &self, groups: &GroupsProxy, quantile: f64, method: QuantileMethod, ) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub unsafe fn agg_median(&self, groups: &GroupsProxy) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub unsafe fn agg_var(&self, groups: &GroupsProxy, ddof: u8) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub unsafe fn agg_list(&self, groups: &GroupsProxy) -> Self

Available on crate feature algorithm_group_by only.

Safety

Does no bounds checks, groups must be correct.

pub fn full_null(name: PlSmallStr, size: usize, dtype: &DataType) -> Self

pub fn is_empty(&self) -> bool

pub fn reverse(&self) -> Column

pub fn equals(&self, right: &Column) -> bool

pub fn equals_missing(&self, right: &Column) -> bool

pub fn set_sorted_flag(&mut self, sorted: IsSorted)

pub fn get_flags(&self) -> MetadataFlags

pub fn get_metadata<'a>(&'a self) -> Option<Box<dyn MetadataTrait + 'a>>

pub fn get_data_ptr(&self) -> usize

pub fn vec_hash( &self, build_hasher: PlRandomState, buf: &mut Vec<u64>, ) -> PolarsResult<()>

pub fn vec_hash_combine( &self, build_hasher: PlRandomState, hashes: &mut [u64], ) -> PolarsResult<()>

pub fn append(&mut self, other: &Column) -> PolarsResult<&mut Self>

pub fn arg_sort(&self, options: SortOptions) -> IdxCa

pub fn bit_repr(&self) -> Option<BitRepr>

pub fn into_frame(self) -> DataFrame

pub fn unique_stable(&self) -> PolarsResult<Column>

pub fn extend(&mut self, other: &Column) -> PolarsResult<&mut Self>

pub fn rechunk(&self) -> Column

pub fn explode(&self) -> PolarsResult<Column>

pub fn fill_null(&self, strategy: FillNullStrategy) -> PolarsResult<Self>

pub fn divide(&self, rhs: &Column) -> PolarsResult<Self>

pub fn shift(&self, periods: i64) -> Column

pub fn zip_with( &self, mask: &BooleanChunked, other: &Self, ) -> PolarsResult<Self>

Available on crate feature zip_with only.

pub fn zip_with_same_type( &self, mask: &ChunkedArray<BooleanType>, other: &Column, ) -> PolarsResult<Column>

Available on crate feature zip_with only.

pub fn drop_nulls(&self) -> Column

pub fn is_sorted_flag(&self) -> IsSorted

pub fn unique(&self) -> PolarsResult<Column>

pub fn reshape_list( &self, dimensions: &[ReshapeDimension], ) -> PolarsResult<Self>

pub fn sort(&self, sort_options: SortOptions) -> PolarsResult<Self>

pub fn filter(&self, filter: &ChunkedArray<BooleanType>) -> PolarsResult<Self>

pub fn shuffle(&self, seed: Option<u64>) -> Self

Available on crate feature random only.

pub fn sample_frac( &self, frac: f64, with_replacement: bool, shuffle: bool, seed: Option<u64>, ) -> PolarsResult<Self>

Available on crate feature random only.

pub fn sample_n( &self, n: usize, with_replacement: bool, shuffle: bool, seed: Option<u64>, ) -> PolarsResult<Self>

Available on crate feature random only.

pub fn gather_every(&self, n: usize, offset: usize) -> Column

pub fn extend_constant( &self, value: AnyValue<'_>, n: usize, ) -> PolarsResult<Self>

pub fn is_finite(&self) -> PolarsResult<BooleanChunked>

pub fn is_infinite(&self) -> PolarsResult<BooleanChunked>

pub fn is_nan(&self) -> PolarsResult<BooleanChunked>

pub fn is_not_nan(&self) -> PolarsResult<BooleanChunked>

pub fn wrapping_trunc_div_scalar<T>(&self, rhs: T) -> Self

where T: Num + NumCast,

pub fn product(&self) -> PolarsResult<Scalar>

pub fn phys_iter(&self) -> SeriesPhysIter<'_>

pub fn get(&self, index: usize) -> PolarsResult<AnyValue<'_>>

pub unsafe fn get_unchecked(&self, index: usize) -> AnyValue<'_>

Safety

Does not perform bounds check on index

pub fn get_object(&self, index: usize) -> Option<&dyn PolarsObjectSafe>

Available on crate feature object only.

pub fn bitand(&self, rhs: &Self) -> PolarsResult<Self>

pub fn max_reduce(&self) -> PolarsResult<Scalar>

pub fn min_reduce(&self) -> PolarsResult<Scalar>

pub fn apply_unary_elementwise(&self, f: impl Fn(&Series) -> Series) -> Column

pub fn try_apply_unary_elementwise( &self, f: impl Fn(&Series) -> PolarsResult<Series>, ) -> PolarsResult<Column>

Trait Implementations

impl<T> Add<T> for &Column

where T: Num + NumCast,

type Output = Column

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T> Add<T> for Column

where T: Num + NumCast,

type Output = Column

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl Add for &Column

type Output = Result<Column, PolarsError>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Add for Column

type Output = Result<Column, PolarsError>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl BitAnd for &Column

type Output = Result<Column, PolarsError>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAnd for Column

type Output = Result<Column, PolarsError>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for &Column

type Output = Result<Column, PolarsError>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOr for Column

type Output = Result<Column, PolarsError>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor for &Column

type Output = Result<Column, PolarsError>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXor for Column

type Output = Result<Column, PolarsError>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl ChunkCompareEq<&Column> for Column

fn equal(&self, rhs: &Column) -> PolarsResult<BooleanChunked>

Create a boolean mask by checking for equality.

fn equal_missing(&self, rhs: &Column) -> PolarsResult<BooleanChunked>

Create a boolean mask by checking for equality.

fn not_equal(&self, rhs: &Column) -> PolarsResult<BooleanChunked>

Create a boolean mask by checking for inequality.

fn not_equal_missing(&self, rhs: &Column) -> PolarsResult<BooleanChunked>

Create a boolean mask by checking for inequality.

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

impl ChunkCompareIneq<&Column> for Column

fn gt(&self, rhs: &Column) -> PolarsResult<BooleanChunked>

Create a boolean mask by checking if self > rhs.

fn gt_eq(&self, rhs: &Column) -> PolarsResult<BooleanChunked>

Create a boolean mask by checking if self >= rhs.

fn lt(&self, rhs: &Column) -> PolarsResult<BooleanChunked>

Create a boolean mask by checking if self < rhs.

fn lt_eq(&self, rhs: &Column) -> PolarsResult<BooleanChunked>

Create a boolean mask by checking if self <= rhs.

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

impl Clone for Column

fn clone(&self) -> Column

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Column

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

Formats the value using the given formatter.

impl Default for Column

fn default() -> Self

Returns the “default value” for a type.

impl<T> Div<T> for &Column

where T: Num + NumCast,

type Output = Column

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T> Div<T> for Column

where T: Num + NumCast,

type Output = Column

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl Div for &Column

type Output = Result<Column, PolarsError>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl Div for Column

type Output = Result<Column, PolarsError>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl From<ScalarColumn> for Column

fn from(value: ScalarColumn) -> Self

Converts to this type from the input type.

impl From<Series> for Column

fn from(series: Series) -> Self

Converts to this type from the input type.

impl FromIterator<Column> for DataFrame

fn from_iter<T: IntoIterator<Item = Column>>(iter: T) -> Self

Panics

Panics if Column have different lengths.

impl IntoColumn for Column

fn into_column(self) -> Column

impl<T> Mul<T> for &Column

where T: Num + NumCast,

type Output = Column

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T> Mul<T> for Column

where T: Num + NumCast,

type Output = Column

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl Mul for &Column

type Output = Result<Column, PolarsError>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Mul for Column

type Output = Result<Column, PolarsError>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl PartialEq for Column

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

Tests for self and other values to be equal, and is used by ==.

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<T> Rem<T> for &Column

where T: Num + NumCast,

type Output = Column

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<T> Rem<T> for Column

where T: Num + NumCast,

type Output = Column

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl Rem for &Column

type Output = Result<Column, PolarsError>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl Rem for Column

type Output = Result<Column, PolarsError>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl<T> Sub<T> for &Column

where T: Num + NumCast,

type Output = Column

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T> Sub<T> for Column

where T: Num + NumCast,

type Output = Column

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl Sub for &Column

type Output = Result<Column, PolarsError>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Sub for Column

type Output = Result<Column, PolarsError>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.