Struct boomphf::hashmap::BoomHashMap

pub struct BoomHashMap<K: Hash, D> { /* fields omitted */ }

A HashMap data structure where the mapping between keys and values is encoded in a Mphf. This lets us store the keys and values in dense arrays, with ~3 bits/item overhead in the Mphf.

Methods

impl<K, D> BoomHashMap<K, D> where     K: Clone + Hash + Debug + PartialEq,     D: Debug,

pub fn new(keys: Vec<K>, data: Vec<D>) -> BoomHashMap<K, D>

Create a new hash map from the parallel array keys and values

pub fn get(&self, kmer: &K) -> Option<&D>

Get the value associated with key, if available, otherwise return None

pub fn get_key_id(&self, kmer: &K) -> Option<usize>

Get the position in the Mphf of a key, if the key exists.

pub fn len(&self) -> usize

Total number of key/value pairs

pub fn get_key(&self, id: usize) -> Option<&K>

Important traits for BoomIterator<'a, K, D>

impl<'a, K: Hash, D> Iterator for BoomIterator<'a, K, D> type Item = (&'a K, &'a D);

pub fn iter(&self) -> BoomIterator<K, D>

impl<K, D> BoomHashMap<K, D> where     K: Clone + Hash + Debug + PartialEq + Send + Sync,     D: Debug,

pub fn new_parallel(keys: Vec<K>, data: Vec<D>) -> BoomHashMap<K, D>

Create a new hash map from the parallel array keys and values, using a parallelized method to construct the Mphf.

Trait Implementations

impl<'a, K: Hash, D> IntoIterator for &'a BoomHashMap<K, D>

type Item = (&'a K, &'a D)

The type of the elements being iterated over.

type IntoIter = BoomIterator<'a, K, D>

Which kind of iterator are we turning this into?

Important traits for BoomIterator<'a, K, D>

impl<'a, K: Hash, D> Iterator for BoomIterator<'a, K, D> type Item = (&'a K, &'a D);

fn into_iter(self) -> BoomIterator<'a, K, D>

Creates an iterator from a value.

impl<K: Debug + Hash, D: Debug> Debug for BoomHashMap<K, D>

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

Formats the value using the given formatter.