Struct MapWithDict

pub struct MapWithDict<K, V, const B: usize = 32, const S: usize = 8, ST = u8, H = WyHash>
where
    ST: PrimInt + Unsigned,
    H: Hasher + Default,
{ /* private fields */ }

An efficient, immutable hash map with values dictionary-packed for optimized space usage.

Implementations

impl<K, V, const B: usize, const S: usize, ST, H> MapWithDict<K, V, B, S, ST, H>

where K: Eq + Hash + Clone, V: Eq + Clone + Hash, ST: PrimInt + Unsigned, H: Hasher + Default,

pub fn from_iter_with_params<I>(iter: I, gamma: f32) -> Result<Self, MphfError>

where I: IntoIterator<Item = (K, V)>,

Constructs a MapWithDict from an iterator of key-value pairs and MPHF function params.

pub fn get<Q>(&self, key: &Q) -> Option<&V>

where K: Borrow<Q> + PartialEq<Q>, Q: Hash + Eq + ?Sized,

Returns a reference to the value corresponding to the key. Returns None if the key is not present in the map.

Examples

let map = MapWithDict::try_from(HashMap::from([(1, 2), (3, 4)])).unwrap();
assert_eq!(map.get(&1), Some(&2));
assert_eq!(map.get(&5), None);

pub fn len(&self) -> usize

Returns the number of key-value pairs in the map.

Examples

let map = MapWithDict::try_from(HashMap::from([(1, 2), (3, 4)])).unwrap();
assert_eq!(map.len(), 2);

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Examples

let map = MapWithDict::try_from(HashMap::from([(0, 0); 0])).unwrap();
assert_eq!(map.is_empty(), true);
let map = MapWithDict::try_from(HashMap::from([(1, 2), (3, 4)])).unwrap();
assert_eq!(map.is_empty(), false);

pub fn contains_key<Q>(&self, key: &Q) -> bool

where K: Borrow<Q> + PartialEq<Q>, Q: Hash + Eq + ?Sized,

Checks if the map contains the specified key.

Examples

let map = MapWithDict::try_from(HashMap::from([(1, 2), (3, 4)])).unwrap();
assert_eq!(map.contains_key(&1), true);
assert_eq!(map.contains_key(&2), false);

pub fn iter(&self) -> impl Iterator<Item = (&K, &V)>

Returns an iterator over the map, yielding key-value pairs.

Examples

let map = MapWithDict::try_from(HashMap::from([(1, 2), (3, 4)])).unwrap();
for (key, val) in map.iter() {
    println!("key: {key} val: {val}");
}

pub fn keys(&self) -> impl Iterator<Item = &K>

Returns an iterator over the keys of the map.

Examples

let map = MapWithDict::try_from(HashMap::from([(1, 2), (3, 4)])).unwrap();
for key in map.keys() {
    println!("{key}");
}

pub fn values(&self) -> impl Iterator<Item = &V>

Returns an iterator over the values of the map.

Examples

let map = MapWithDict::try_from(HashMap::from([(1, 2), (3, 4)])).unwrap();
for val in map.values() {
    println!("{val}");
}

pub fn size(&self) -> usize

Returns the total number of bytes occupied by the structure.

Examples

let map = MapWithDict::try_from(HashMap::from([(1, 2), (3, 4)])).unwrap();
assert_eq!(map.size(), 270);

Trait Implementations

impl<K, V> TryFrom<HashMap<K, V>> for MapWithDict<K, V>

where K: Eq + Hash + Clone, V: Eq + Clone + Hash,

Creates a MapWithDict from a HashMap.

type Error = MphfError

The type returned in the event of a conversion error.

fn try_from(value: HashMap<K, V>) -> Result<Self, Self::Error>

Performs the conversion.