Struct ph::FPHash2

pub struct FPHash2<GS: GroupSize = TwoToPowerBits, SS: SeedSize = TwoToPowerBitsStatic<2>, S = BuildDefaultSeededHasher> { /* private fields */ }

Fingerprinting-based minimal perfect hash function with group optimization (FMPHGO).

See:

• P. Beling, Fingerprinting-based minimal perfect hashing revisited

Implementations

impl<GS: GroupSize + Sync, SS: SeedSize, S: BuildSeededHasher + Sync> FPHash2<GS, SS, 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_builder_stats<K, KS, BS>(
    keys: KS,
    levels: FPHash2Builder<GS, SS, S>,
    stats: &mut BS
) -> Selfwhere
    K: Hash + Sync,
    KS: KeySet<K> + Sync,
    BS: BuildStatsCollector,

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

pub fn with_builder<K, KS>(keys: KS, levels: FPHash2Builder<GS, SS, S>) -> Selfwhere
    K: Hash + Sync,
    KS: KeySet<K> + Sync,

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

pub fn with_conf_mt_stats<K, KS, BS>(
    keys: KS,
    conf: FPHash2Conf<GS, SS, S>,
    use_multiple_threads: bool,
    stats: &mut BS
) -> Selfwhere
    K: Hash + Sync,
    KS: KeySet<K> + Sync,
    BS: BuildStatsCollector,

pub fn with_conf<K, KS>(keys: KS, conf: FPHash2Conf<GS, SS, S>) -> Selfwhere
    K: Hash + Sync,
    KS: KeySet<K> + Sync,

pub fn with_conf_mt<K, KS>(
    keys: KS,
    conf: FPHash2Conf<GS, SS, S>,
    use_multiple_threads: bool
) -> Selfwhere
    K: Hash + Sync,
    KS: KeySet<K> + Sync,

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

Builds FPHash2 for given keys, using the configuration conf.

pub fn from_slice_with_conf_mt_stats<K, BS>(
    keys: &[K],
    conf: FPHash2Conf<GS, SS, S>,
    use_multiple_threads: bool,
    stats: &mut BS
) -> Selfwhere
    K: Hash + Sync,
    BS: BuildStatsCollector,

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

Builds FPHash2 for given keys, using the configuration conf.

pub fn from_slice_with_conf_mt<K>(
    keys: &[K],
    conf: FPHash2Conf<GS, SS, S>,
    use_multiple_threads: bool
) -> Selfwhere
    K: Hash + Sync,

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

Builds FPHash2 for given keys, using the configuration conf.

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

Builds FPHash2 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.

pub fn level_sizes(&self) -> &[u64]

impl<GS: GroupSize + Sync, SS: SeedSize> FPHash2<GS, SS>

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

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

impl FPHash2

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

Builds FPHash2 for given keys, reporting statistics to stats.

pub fn from_slice<K: Hash + Sync>(keys: &[K]) -> Self

Builds FPHash2 for given keys.

Trait Implementations

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

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

Converts to this type from the input type.

impl<GS: GroupSize, SS: SeedSize, S: BuildSeededHasher> GetSize for FPHash2<GS, SS, 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).

const USES_DYN_MEM: bool = true

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

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).

fn size_bytes(&self) -> usize

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