Struct cmprsd::huffman::Frequency

pub struct Frequency {
    pub count: usize,
    pub character: Option<char>,
}

Struct that represents the frequency of the different characters found in a string.

Fields

count: usize

frequency is a value between 0 and 65536 and is equal to n/65536

character: Option<char>

char that the frequency represents. It is optional as in when we store frequencies in the Huffman tree we have nodes that hold a combined frequency of the two children but do not hold any character.

Implementations

impl Frequency

pub fn build_frequency(count: usize, character: Option<char>) -> Frequency

instanciate a frequency.

Trait Implementations

impl Clone for Frequency

fn clone(&self) -> Frequency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frequency

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

Formats the value using the given formatter.

impl Display for Frequency

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

Formats the value using the given formatter.

impl Ord for Frequency

fn cmp(&self, other: &Frequency) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Frequency

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Frequency

fn partial_cmp(&self, other: &Frequency) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Frequency

impl Eq for Frequency

impl StructuralPartialEq for Frequency