ph 0.11.0

The library of data structures based on perfect hashing.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! Collecting and reporting building and querying statistics.

use std::io::Write;

/// Trait for collecting (and summarizing or reporting) events during construction of a minimal perfect hashing function.
pub trait BuildStatsCollector {
    /// Called once at each level to indicate sizes of input and level. Default implementation do nothing.
    #[inline(always)] fn level(&mut self, _input_size: usize, _level_size: usize) {}

    /// Called once at the end of the building process with number of remaining (unsupported) keys (0 when construction has been successful).
    /// Default implementation do nothing.
    #[inline(always)] fn end(&mut self, _remaining_keys: usize) {}
}

/// Ignores all events and does nothing.
impl BuildStatsCollector for () {}

/// Report events occurred during building a minimal perfect hashing function to the wrapped writer.
pub struct BuildStatsPrinter<W: Write = std::io::Stdout>(W);

impl BuildStatsPrinter<std::io::Stdout> {
    /// Report events occurred during building a minimal perfect hashing function to the standard output.
    pub fn stdout() -> Self { Self(std::io::stdout()) }
}

impl<W: Write> BuildStatsCollector for BuildStatsPrinter<W> {
    fn level(&mut self, input_size: usize, level_size: usize) {
        writeln!(self.0, "{} {}", input_size, level_size).unwrap();
    }

    fn end(&mut self, remaining_keys: usize) {
        writeln!(self.0, "Completed {}. {} keys remaining.", if remaining_keys == 0 { "successfully" } else { "unsuccessfully" }, remaining_keys).unwrap();
    }
}

/// Trait for collecting (and summarizing or reporting) events during querying of a minimal perfect hashing function.
pub trait AccessStatsCollector {
    /// Lookup algorithm calls this method to report that a value has been just found at given level (counting from 0).
    /// The single lookup can call `found_on_level` few times if it finds the fragments on value at different levels.
    #[inline(always)] fn found_on_level(&mut self, _level_nr: usize) {}

    /// Lookup algorithm calls this method to report that a value has not been found and reports number of level searched (counting from 0).
    #[inline(always)] fn fail_on_level(&mut self, _level_nr: usize) {}
}

/// Ignores all events and does nothing.
impl AccessStatsCollector for () {}

/// Increases own value by the number of levels visited, regardless of the result of the search.
impl AccessStatsCollector for usize {
    #[inline(always)] fn found_on_level(&mut self, level_nr: usize) { *self += level_nr + 1; }
    #[inline(always)] fn fail_on_level(&mut self, level_nr: usize) { *self += level_nr + 1; }
}