Struct ph::FPHash

pub struct FPHash<S = BuildDefaultSeededHasher> { /* private fields */ }

Fingerprinting-based minimal perfect hash function (FMPH).

See:

• A. Limasset, G. Rizk, R. Chikhi, P. Peterlongo, Fast and Scalable Minimal Perfect Hashing for Massive Key Sets, SEA 2017
• P. Beling, Fingerprinting-based minimal perfect hashing revisited

Implementations

impl<S: BuildSeededHasher + Sync> FPHash<S>

pub fn get_stats<K: Hash, A: AccessStatsCollector>(
    &self,
    key: &K,
    access_stats: &mut A
) -> Option<u64>

Gets the value associated with the given key and reports statistics to access_stats.

pub fn get<K: Hash>(&self, key: &K) -> Option<u64>

Gets the value associated with the given key.

pub fn with_conf_stats<K, BS>(
    keys: impl KeySet<K>,
    conf: FPHashConf<S>,
    stats: &mut BS
) -> Selfwhere
    K: Hash + Sync,
    BS: BuildStatsCollector,

Builds FPHash for given keys, using the configuration conf and reporting statistics to stats.

pub fn with_conf<K>(keys: impl KeySet<K>, conf: FPHashConf<S>) -> Selfwhere
    K: Hash + Sync,

Builds FPHash for given keys, using the configuration conf.

pub fn from_slice_with_conf_stats<K, BS>(
    keys: &[K],
    conf: FPHashConf<S>,
    stats: &mut BS
) -> Selfwhere
    K: Hash + Sync,
    BS: BuildStatsCollector,

Builds FPHash for given keys, using the configuration conf.

pub fn from_slice_with_conf<K>(keys: &[K], conf: FPHashConf<S>) -> Selfwhere
    K: Hash + Sync,

Builds FPHash for given keys, using the configuration conf.

pub fn from_slice_mut_with_conf_stats<K, BS>(
    keys: &mut [K],
    conf: FPHashConf<S>,
    stats: &mut BS
) -> Selfwhere
    K: Hash + Sync,
    BS: BuildStatsCollector,

Builds FPHash for given keys, using the configuration conf.

pub fn from_slice_mut_with_conf<K>(keys: &mut [K], conf: FPHashConf<S>) -> Selfwhere
    K: Hash + Sync,

Builds FPHash for given keys, using the configuration conf.

pub fn write_bytes(&self) -> usize

Returns number of bytes which write will write.

pub fn write(&self, output: &mut dyn Write) -> Result<()>

Writes self to the output.

pub fn read_with_hasher(input: &mut dyn Read, hasher: S) -> Result<Self>

Reads Self from the input. Hasher must be the same as the one used to write.

impl FPHash

pub fn read(input: &mut dyn Read) -> Result<Self>

Reads Self from the input. Only FPHashs that use default hasher can be read by this method.

pub fn with_stats<K, BS>(keys: impl KeySet<K>, stats: &mut BS) -> Selfwhere
    K: Hash + Sync,
    BS: BuildStatsCollector,

Builds FPHash for given keys, reporting statistics to stats.

pub fn new<K: Hash + Sync>(keys: impl KeySet<K>) -> Self

Builds FPHash for given keys.

Trait Implementations

impl<S: Clone> Clone for FPHash<S>

fn clone(&self) -> FPHash<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Hash + Clone + Sync> From<&[K]> for FPHash

fn from(keys: &[K]) -> Self

Converts to this type from the input type.

impl<S: BuildSeededHasher> GetSize for FPHash<S>

fn size_bytes_dyn(&self) -> usize

Returns approximate number of bytes occupied by dynamic (heap) part of self. Same as self.size_bytes() - std::mem::size_of_val(self).

fn size_bytes_content_dyn(&self) -> usize

Returns approximate number of bytes occupied by dynamic (heap) part of self content. It usually equals to size_bytes_dyn(). However, sometimes it is smaller by the amount of memory reserved but not yet used (e.g., size_bytes_content_dyn() only takes into account the length of the vector and not its capacity).

const USES_DYN_MEM: bool = true

true if and only if the variables of this type can use dynamic (heap) memory.

fn size_bytes(&self) -> usize

Returns approximate, total (including heap memory) number of bytes occupied by self.