Struct polars::prelude::CategoricalChunked

pub struct CategoricalChunked { /* private fields */ }

Implementations

impl CategoricalChunked

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

Available on crate feature dtype-categorical only.

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

Available on crate feature dtype-categorical only.

Returned a sorted ChunkedArray.

pub fn arg_sort(&self, options: SortOptions) -> ChunkedArray<UInt32Type>

Available on crate feature dtype-categorical only.

Retrieve the indexes needed to sort this array.

impl CategoricalChunked

pub unsafe fn from_global_indices_unchecked( cats: ChunkedArray<UInt32Type> ) -> CategoricalChunked

Available on crate feature dtype-categorical only.

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

Safety

This does not do any bound checks

impl CategoricalChunked

pub fn append(&mut self, other: &CategoricalChunked) -> Result<(), PolarsError>

Available on crate feature dtype-categorical only.

impl CategoricalChunked

pub fn full_null(name: &str, length: usize) -> CategoricalChunked

Available on crate feature dtype-categorical only.

impl CategoricalChunked

pub fn unique(&self) -> Result<CategoricalChunked, PolarsError>

Available on crate feature dtype-categorical only.

pub fn n_unique(&self) -> Result<usize, PolarsError>

Available on crate feature dtype-categorical only.

pub fn value_counts(&self) -> Result<DataFrame, PolarsError>

Available on crate feature dtype-categorical only.

impl CategoricalChunked

pub fn is_empty(&self) -> bool

Available on crate feature dtype-categorical only.

pub fn len(&self) -> usize

Available on crate feature dtype-categorical only.

pub fn null_count(&self) -> usize

Available on crate feature dtype-categorical only.

pub fn name(&self) -> &str

Available on crate feature dtype-categorical only.

pub fn physical(&self) -> &ChunkedArray<UInt32Type>

Available on crate feature dtype-categorical only.

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

pub fn to_local(&self) -> CategoricalChunked

Available on crate feature dtype-categorical only.

Convert a categorical column to its local representation.

pub fn set_lexical_ordering(&mut self, toggle: bool)

Available on crate feature dtype-categorical only.

pub fn uses_lexical_ordering(&self) -> bool

Available on crate feature dtype-categorical only.

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

pub unsafe fn from_cats_and_rev_map_unchecked( idx: ChunkedArray<UInt32Type>, rev_map: Arc<RevMapping> ) -> CategoricalChunked

Available on crate feature dtype-categorical only.

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 get_rev_map(&self) -> &Arc<RevMapping>

Available on crate feature dtype-categorical only.

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

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

Available on crate feature dtype-categorical only.

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

Trait Implementations

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 From<&CategoricalChunked> for DictionaryArray<i64>

fn from(ca: &CategoricalChunked) -> DictionaryArray<i64>

Converts to this type from the input type.

impl From<&CategoricalChunked> for DictionaryArray<u32>

fn from(ca: &CategoricalChunked) -> DictionaryArray<u32>

Converts to this type from the input type.

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) -> Result<AnyValue<'_>, PolarsError>

Gets AnyValue from LogicalType

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

Safety

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