Enum lace_codebook::ValueMap

pub enum ValueMap {
    String(CategoryMap<String>),
    U8(usize),
    Bool,
}

Variants

String(CategoryMap<String>)

U8(usize)

Bool

Implementations

impl ValueMap

pub fn new<T>(cats: BTreeSet<T>) -> Selfwhere Self: From<BTreeSet<T>>,

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn ix(&self, cat: &Category) -> Option<usize>

Get the usize index of the category if it exists

Examples

let mut cats: BTreeSet<String> = BTreeSet::new();

cats.insert("B".into());
cats.insert("C".into());
cats.insert("A".into());

let value_map = ValueMap::new(cats);

assert_eq!(value_map.ix(&Category::String("A".into())), Some(0));
assert_eq!(value_map.ix(&Category::String("B".into())), Some(1));
assert_eq!(value_map.ix(&Category::String("C".into())), Some(2));
assert_eq!(value_map.ix(&Category::String("D".into())), None);

pub fn category(&self, ix: usize) -> Category

Get the category associated with an index

Examples

let mut cats: BTreeSet<String> = BTreeSet::new();

cats.insert("B".into());
cats.insert("C".into());
cats.insert("A".into());

let value_map = ValueMap::new(cats);

assert_eq!(value_map.category(0), Category::String("A".into()));
assert_eq!(value_map.category(1), Category::String("B".into()));
assert_eq!(value_map.category(2), Category::String("C".into()));

pub fn contains_cat(&self, cat: &Category) -> bool

pub fn iter(&self) -> CategoryIter<'_>

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

Determine whether a value map is an extended version of this value map

Examples

use std::collections::BTreeSet;
use lace_data::Category;

let mut cats: BTreeSet<String> = BTreeSet::new();

cats.insert("B".into());
cats.insert("C".into());
cats.insert("A".into());

let value_map_1 = ValueMap::new(cats.clone());

assert!(value_map_1.is_extended(&value_map_1));

cats.insert("D".into());

let value_map_2 = ValueMap::new(cats);

assert!(value_map_1.len() < value_map_2.len());
assert!(value_map_1.is_extended(&value_map_2));
assert!(!value_map_2.is_extended(&value_map_1));

Integer valuemap

let value_map_1 = ValueMap::U8(2);
let value_map_2 = ValueMap::U8(3);
let value_map_3 = ValueMap::U8(4);

assert!(value_map_1.is_extended(&value_map_1));
assert!(value_map_1.is_extended(&value_map_2));
assert!(value_map_1.is_extended(&value_map_3));

assert!(!value_map_2.is_extended(&value_map_1));
assert!(value_map_2.is_extended(&value_map_2));
assert!(value_map_2.is_extended(&value_map_3));

assert!(!value_map_3.is_extended(&value_map_1));
assert!(!value_map_3.is_extended(&value_map_2));
assert!(value_map_3.is_extended(&value_map_3));

let value_map = ValueMap::Bool;

assert!(value_map.is_extended(&value_map));

Trait Implementations

impl Clone for ValueMap

fn clone(&self) -> ValueMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValueMap

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ValueMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BTreeSet<String, Global>> for ValueMap

fn from(cats: BTreeSet<String>) -> Self

Converts to this type from the input type.

impl PartialEq<ValueMap> for ValueMap

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ValueMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Vec<String, Global>> for ValueMap

type Error = String

The type returned in the event of a conversion error.

fn try_from(cats: Vec<String>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ValueMap

impl StructuralEq for ValueMap

impl StructuralPartialEq for ValueMap