EncodingScheme

Enum EncodingScheme 

Source
pub enum EncodingScheme {
    BalancedTree,
    Fano,
    Shannon,
    Huffman,
}
Expand description

Encoding schems (i.e. the compression algorithms) supported by this library.

Variants§

§

BalancedTree

Create a new balanced tree encoding.

All letters in this encoding are fixed width bit strings. The smallest width necessary to generate the required number of letters for all input tokens is used.

§

Fano

Create a new Fano encoding.

§

Shannon

Create a new Shannon encoding.

The Shannon encoding scheme is defined thus:

Let the tokens, sorted in decreasing order of frequency be t1, t2, t3 ...

Let the probability of occurrence of the Tokens be f1, f2, f3 ...

Define the numbers l1, l2, l3 ... such that lk = ceil(log2(1/fk))

Let the (computed) cumulative proportions be c1, c2, c3 ...

Then, the code is e1, e2, e3 ... such that ek = first lk bits of the binary expansion of Fk.

§

Huffman

Create a new Huffman encoding.

Of the algorithms implemented in this library, this is closest to practical compression libraries used widely - e.g., deflate, jpeg and mp3 use a Huffman-like encoding in their backends.

Trait Implementations§

Source§

impl Clone for EncodingScheme

Source§

fn clone(&self) -> EncodingScheme

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
Source§

impl Debug for EncodingScheme

Source§

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

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

impl Hash for EncodingScheme

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for EncodingScheme

Source§

fn eq(&self, other: &EncodingScheme) -> 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 EncodingScheme

Source§

impl Eq for EncodingScheme

Source§

impl StructuralPartialEq for EncodingScheme

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> 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.