Struct CodesStats

pub struct CodesStats<const ZETA: usize = 10, const GOLOMB: usize = 20, const EXP_GOLOMB: usize = 10, const RICE: usize = 10, const PI: usize = 10> {
    pub total: u64,
    pub unary: u64,
    pub gamma: u64,
    pub delta: u64,
    pub omega: u64,
    pub vbyte: u64,
    pub zeta: [u64; ZETA],
    pub golomb: [u64; GOLOMB],
    pub exp_golomb: [u64; EXP_GOLOMB],
    pub rice: [u64; RICE],
    pub pi: [u64; PI],
}

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

total: u64

The total number of elements observed.

unary: u64

The total space used to store the elements if they were stored using the unary code.

gamma: u64

The total space used to store the elements if they were stored using the gamma code.

delta: u64

The total space used to store the elements if they were stored using the delta code.

omega: u64

The total space used to store the elements if they were stored using the omega code.

vbyte: u64

The total space used to store the elements if they were stored using the variable byte code.

zeta: [u64; ZETA]

The total space used to store the elements if they were stored using the zeta code.

golomb: [u64; GOLOMB]

The total space used to store the elements if they were stored using the Golomb code.

exp_golomb: [u64; EXP_GOLOMB]

The total space used to store the elements if they were stored using the exponential Golomb code.

rice: [u64; RICE]

The total space used to store the elements if they were stored using the Rice code.

pi: [u64; PI]

The total space used to store the elements if they were stored using the Pi code.

Implementations

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

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 update_many(&mut self, n: u64, count: u64) -> u64

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

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

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

Trait Implementations

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> Add for CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

Combines additively this stats with another one creating a new one.

type Output = CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> AddAssign for CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

Combines additively this stats with another one.

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> Clone for CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

fn clone(&self) -> CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> CopyType for CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

where u64: MemSize, [u64; ZETA]: MemSize, [u64; GOLOMB]: MemSize, [u64; EXP_GOLOMB]: MemSize, [u64; RICE]: MemSize, [u64; PI]: MemSize,

type Copy = False

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> Debug for CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

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

Formats the value using the given formatter.

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> Default for CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

fn default() -> Self

Returns the “default value” for a type.

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> MemDbgImpl for CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

where u64: MemDbgImpl, [u64; ZETA]: MemDbgImpl, [u64; GOLOMB]: MemDbgImpl, [u64; EXP_GOLOMB]: MemDbgImpl, [u64; RICE]: MemDbgImpl, [u64; PI]: MemDbgImpl,

fn _mem_dbg_rec_on( &self, _memdbg_writer: &mut impl Write, _memdbg_total_size: usize, _memdbg_max_depth: usize, _memdbg_prefix: &mut String, _memdbg_is_last: bool, _memdbg_flags: DbgFlags, ) -> Result

fn _mem_dbg_depth_on( &self, writer: &mut impl Write, total_size: usize, max_depth: usize, prefix: &mut String, field_name: Option<&str>, is_last: bool, padded_size: usize, flags: DbgFlags, ) -> Result<(), Error>

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> MemSize for CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

where u64: MemSize, [u64; ZETA]: MemSize, [u64; GOLOMB]: MemSize, [u64; EXP_GOLOMB]: MemSize, [u64; RICE]: MemSize, [u64; PI]: MemSize,

fn mem_size(&self, _memsize_flags: SizeFlags) -> usize

Returns the (recursively computed) overall memory size of the structure in bytes.

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> Sum for CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>

Allow to call .sum() on an iterator of CodesStats.

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<const ZETA: usize, const GOLOMB: usize, const EXP_GOLOMB: usize, const RICE: usize, const PI: usize> Copy for CodesStats<ZETA, GOLOMB, EXP_GOLOMB, RICE, PI>