Struct dsi_bitstream::utils::CodesStats

pub struct CodesStats {
    pub unary: u64,
    pub gamma: u64,
    pub delta: u64,
    pub zeta: [u64; 10],
    pub golomb: [u64; 20],
}

Keeps track of the space needed to store a stream of integers using different codes.

This structure can be used to determine empirically which code provides the best compression for a given stream. You have to update the structure with the integers in the stream; at any time, you can examine the statistics or call best_code to get the best code.

Fields

unary: u64

gamma: u64

delta: u64

zeta: [u64; 10]

golomb: [u64; 20]

Implementations

impl CodesStats

pub fn update(&mut self, n: u64) -> u64

Update the stats with the lengths of the codes for n and return n for convenience.

pub fn add(&mut self, rhs: &Self)

pub fn best_code(&self) -> (Code, u64)

Return the best code for the stream and its space usage.

Trait Implementations

impl Debug for CodesStats

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

Formats the value using the given formatter.

impl Default for CodesStats

fn default() -> CodesStats

Returns the “default value” for a type.