Struct polars_core::prelude::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, reverse: bool) -> CategoricalChunked

Returned a sorted ChunkedArray.

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

Retrieve the indexes needed to sort this array.

impl CategoricalChunked

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

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: &Self) -> PolarsResult<()>

impl CategoricalChunked

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

impl CategoricalChunked

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

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

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

impl CategoricalChunked

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn name(&self) -> &str

pub fn logical(&self) -> &UInt32Chunked

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

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

pub unsafe fn from_cats_and_rev_map_unchecked(
    idx: UInt32Chunked,
    rev_map: Arc<RevMapping>
) -> 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 be hold.

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 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) -> Self

Converts to this type from the input type.

impl From<&CategoricalChunked> for DictionaryArray<u32>

fn from(ca: &CategoricalChunked) -> Self

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) -> PolarsResult<AnyValue<'_>>

Gets AnyValue from LogicalType

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

Safety

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