Struct FrozenCategories

pub struct FrozenCategories { /* private fields */ }

An ordered collection of unique strings with an associated pre-computed mapping to go from string <-> index.

FrozenCategories are globally unique to facilitate constant-time comparison.

Implementations

impl FrozenCategories

pub fn new<'a, I>( physical: CategoricalPhysical, strings: I, ) -> Result<Arc<FrozenCategories>, PolarsError>

where I: Iterator<Item = &'a str>,

Creates a new FrozenCategories object (or returns a reference to an existing one in case these are already known). Returns an error if the categories are not unique. It is guaranteed that the nth string ends up with category n (0-indexed).

pub fn mapping(&self) -> &Arc<CategoricalMapping>

The mapping for this FrozenCategories object.

Trait Implementations

impl Drop for FrozenCategories

fn drop(&mut self)

Executes the destructor for this type.