Struct Calculator

pub struct Calculator { /* private fields */ }

An entropy calculator

Example

 // we need Write because that is how values are collected for calculation
 use std::io::Write;
 use tropy::Calculator;

 let mut c = Calculator::new();
 // write some bytes
 c.write(&[0u8]).unwrap();
 c.write(&[1u8]).unwrap();

 // calculate the entropy over the accumulated state
 let e = c.entropy();
 assert_eq!(e,1.0);

Implementations

impl Calculator

pub fn new() -> Self

Instantiate a new calculator.

pub fn entropy(&mut self) -> f64

Calculate Shannon entropy over the bytes written so far and clear the calculator’s internal state.

Trait Implementations

impl Default for Calculator

fn default() -> Self

Returns the “default value” for a type.

impl Write for Calculator

fn write(&mut self, input: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.