Struct GroupComparisonMetrics

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

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§

Source§

impl GroupComparisonMetrics

Source

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§

Source§

impl Clone for GroupComparisonMetrics

Source§

fn clone(&self) -> GroupComparisonMetrics

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GroupComparisonMetrics

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GroupComparisonMetrics

Source§

fn default() -> GroupComparisonMetrics

Returns the “default value” for a type. Read more
Source§

impl PartialEq for GroupComparisonMetrics

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for GroupComparisonMetrics

Source§

impl StructuralPartialEq for GroupComparisonMetrics

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.