Skip to main content

MinEntropyReport

openentropy_core::conditioning

Struct MinEntropyReport

pub struct MinEntropyReport {
    pub shannon_entropy: f64,
    pub min_entropy: f64,
    pub mcv_estimate: f64,
    pub mcv_p_upper: f64,
    pub collision_estimate: f64,
    pub markov_estimate: f64,
    pub compression_estimate: f64,
    pub t_tuple_estimate: f64,
    pub samples: usize,
}

Expand description

Min-entropy analysis report with individual estimator results.

Fields§

§shannon_entropy: f64

Shannon entropy (bits/byte, max 8.0). Upper bound, not conservative.

§min_entropy: f64

Combined min-entropy estimate (bits/byte). Most conservative across all estimators.

§mcv_estimate: f64

Most Common Value estimator (NIST 6.3.1)

§mcv_p_upper: f64

Upper bound on max probability from MCV

§collision_estimate: f64

Collision estimator (NIST 6.3.2)

§markov_estimate: f64

Markov estimator (NIST 6.3.3)

§compression_estimate: f64

Compression estimator (NIST 6.3.4)

§t_tuple_estimate: f64

t-Tuple estimator (NIST 6.3.5)

§samples: usize

Number of samples analyzed

Trait Implementations§

impl Clone for MinEntropyReport

fn clone(&self) -> MinEntropyReport

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for MinEntropyReport

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

Formats the value using the given formatter. Read more

impl Display for MinEntropyReport

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for MinEntropyReport

impl RefUnwindSafe for MinEntropyReport

impl Send for MinEntropyReport

impl Sync for MinEntropyReport

impl Unpin for MinEntropyReport

impl UnwindSafe for MinEntropyReport

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V