Struct GroupComparisonMetrics

pub struct GroupComparisonMetrics {
    pub lz_matches: u64,
    pub entropy: f64,
    pub estimated_size: u64,
    pub zstd_size: u64,
    pub original_size: u64,
}

The statistics for a given group of fields. This can be a group created by the split_comparison module, the compare_groups module or any other piece of code that compares multiple sets of bytes.

Fields

lz_matches: u64

Number of total LZ matches

entropy: f64

Amount of entropy in the input data set

estimated_size: u64

Size estimated by the size estimator function.

zstd_size: u64

Size compressed by zstd.

original_size: u64

Size of the original data.

Implementations

impl GroupComparisonMetrics

pub fn from_bytes( bytes: &[u8], group_name: &str, compression_options: CompressionOptions, ) -> Self

Calculates group comparison metrics for a given byte slice.

This function computes various metrics such as entropy, LZ matches, estimated size, and Zstandard compressed size, which are used for comparing different compression strategies.

Arguments

• bytes - A slice of bytes representing the data to analyze.
• group_name - The name of the group being analyzed.
• compression_options - Compression options, zstd compression level, etc.

Returns

A GroupComparisonMetrics struct containing the computed metrics.

Trait Implementations

impl Clone for GroupComparisonMetrics

fn clone(&self) -> GroupComparisonMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupComparisonMetrics

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

Formats the value using the given formatter.

impl Default for GroupComparisonMetrics

fn default() -> GroupComparisonMetrics

Returns the “default value” for a type.

impl PartialEq for GroupComparisonMetrics

fn eq(&self, other: &GroupComparisonMetrics) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for GroupComparisonMetrics

impl StructuralPartialEq for GroupComparisonMetrics