Struct CategoricalChunked

pub struct CategoricalChunked { /* private fields */ }

Available on crate feature dtype-categorical only.

Implementations

impl CategoricalChunked

pub fn sort_with(&self, options: SortOptions) -> CategoricalChunked

pub fn sort(&self, descending: bool) -> CategoricalChunked

Returned a sorted ChunkedArray.

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

Retrieve the indexes needed to sort this array.

impl CategoricalChunked

pub unsafe fn from_global_indices_unchecked( cats: UInt32Chunked, ordering: CategoricalOrdering, ) -> CategoricalChunked

Create a CategoricalChunked from a categorical indices. The indices will probe the global string cache.

Safety

This does not do any bound checks

pub fn from_string_to_enum( values: &StringChunked, categories: &Utf8ViewArray, ordering: CategoricalOrdering, ) -> PolarsResult<CategoricalChunked>

Create a CategoricalChunked from a fixed list of categories and a List of strings. This will error if a string is not in the fixed list of categories

impl CategoricalChunked

pub fn to_arrow(&self, compat_level: CompatLevel, as_i64: bool) -> ArrayRef

impl CategoricalChunked

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

impl CategoricalChunked

pub fn full_null( name: PlSmallStr, is_enum: bool, length: usize, ordering: CategoricalOrdering, ) -> CategoricalChunked

impl CategoricalChunked

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

Available on crate feature algorithm_group_by only.

pub fn n_unique(&self) -> PolarsResult<usize>

Available on crate feature algorithm_group_by only.

pub fn value_counts(&self) -> PolarsResult<DataFrame>

Available on crate feature algorithm_group_by only.

impl CategoricalChunked

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn null_count(&self) -> usize

pub fn name(&self) -> &PlSmallStr

pub fn physical(&self) -> &UInt32Chunked

Get a reference to the physical array (the categories).

pub fn is_enum(&self) -> bool

pub fn to_local(&self) -> Self

Convert a categorical column to its local representation.

pub fn to_global(&self) -> PolarsResult<Self>

pub fn to_enum(&self, categories: &Utf8ViewArray, hash: u128) -> Self

pub fn uses_lexical_ordering(&self) -> bool

Return whether or not the CategoricalChunked uses the lexical order of the string values when sorting.

pub unsafe fn from_cats_and_dtype_unchecked( idx: UInt32Chunked, dtype: DataType, ) -> Self

Create a CategoricalChunked from a physical array and dtype.

Safety

It’s not checked that the indices are in-bounds or that the dtype is correct.

pub unsafe fn from_cats_and_rev_map_unchecked( idx: UInt32Chunked, rev_map: Arc<RevMapping>, is_enum: bool, ordering: CategoricalOrdering, ) -> Self

Create a CategoricalChunked from an array of idx and an existing RevMapping: rev_map.

Safety

Invariant in v < rev_map.len() for v in idx must hold.

pub fn _can_fast_unique(&self) -> bool

True if all categories are represented in this array. When this is the case, the unique values of the array are the categories.

pub unsafe fn _with_fast_unique(self, toggle: bool) -> Self

Set FAST_UNIQUE metadata

Safety

This invariant must hold unique(categories) == unique(self)

pub fn get_rev_map(&self) -> &Arc<RevMapping>

Get a reference to the mapping of categorical types to the string values.

pub fn iter_str(&self) -> CatIter<'_>

Create an Iterator that iterates over the &str values of the CategoricalChunked.

Trait Implementations

impl ChunkAggSeries for CategoricalChunked

fn min_reduce(&self) -> Scalar

Get the min of the ChunkedArray as a new Series of length 1.

fn max_reduce(&self) -> Scalar

Get the max of the ChunkedArray as a new Series of length 1.

fn sum_reduce(&self) -> Scalar

Get the sum of the ChunkedArray as a new Series of length 1.

fn prod_reduce(&self) -> Scalar

Get the product of the ChunkedArray as a new Series of length 1.

impl ChunkCompareEq<&CategoricalChunked> for CategoricalChunked

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

fn equal(&self, rhs: &CategoricalChunked) -> Self::Item

Check for equality.

fn equal_missing(&self, rhs: &CategoricalChunked) -> Self::Item

Check for equality where None == None.

fn not_equal(&self, rhs: &CategoricalChunked) -> Self::Item

Check for inequality.

fn not_equal_missing(&self, rhs: &CategoricalChunked) -> Self::Item

Check for inequality where None == None.

impl ChunkCompareEq<&ChunkedArray<StringType>> for CategoricalChunked

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

fn equal(&self, rhs: &StringChunked) -> Self::Item

Check for equality.

fn equal_missing(&self, rhs: &StringChunked) -> Self::Item

Check for equality where None == None.

fn not_equal(&self, rhs: &StringChunked) -> Self::Item

Check for inequality.

fn not_equal_missing(&self, rhs: &StringChunked) -> Self::Item

Check for inequality where None == None.

impl ChunkCompareEq<&str> for CategoricalChunked

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

fn equal(&self, rhs: &str) -> Self::Item

Check for equality.

fn equal_missing(&self, rhs: &str) -> Self::Item

Check for equality where None == None.

fn not_equal(&self, rhs: &str) -> Self::Item

Check for inequality.

fn not_equal_missing(&self, rhs: &str) -> Self::Item

Check for inequality where None == None.

impl ChunkCompareIneq<&CategoricalChunked> for CategoricalChunked

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

fn gt(&self, rhs: &CategoricalChunked) -> Self::Item

Greater than comparison.

fn gt_eq(&self, rhs: &CategoricalChunked) -> Self::Item

Greater than or equal comparison.

fn lt(&self, rhs: &CategoricalChunked) -> Self::Item

Less than comparison.

fn lt_eq(&self, rhs: &CategoricalChunked) -> Self::Item

Less than or equal comparison

impl ChunkCompareIneq<&ChunkedArray<StringType>> for CategoricalChunked

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

fn gt(&self, rhs: &StringChunked) -> Self::Item

Greater than comparison.

fn gt_eq(&self, rhs: &StringChunked) -> Self::Item

Greater than or equal comparison.

fn lt(&self, rhs: &StringChunked) -> Self::Item

Less than comparison.

fn lt_eq(&self, rhs: &StringChunked) -> Self::Item

Less than or equal comparison

impl ChunkCompareIneq<&str> for CategoricalChunked

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

fn gt(&self, rhs: &str) -> Self::Item

Greater than comparison.

fn gt_eq(&self, rhs: &str) -> Self::Item

Greater than or equal comparison.

fn lt(&self, rhs: &str) -> Self::Item

Less than comparison.

fn lt_eq(&self, rhs: &str) -> Self::Item

Less than or equal comparison

impl Clone for CategoricalChunked

fn clone(&self) -> CategoricalChunked

Returns a copy of the value.

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

Performs copy-assignment from source.

impl IntoSeries for CategoricalChunked

fn into_series(self) -> Series

fn is_series() -> bool

impl LogicalType for CategoricalChunked

fn dtype(&self) -> &DataType

Get data type of ChunkedArray.

fn get_any_value(&self, i: usize) -> PolarsResult<AnyValue<'_>>

Gets AnyValue from LogicalType

unsafe fn get_any_value_unchecked(&self, i: usize) -> AnyValue<'_>

Safety

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

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