Struct stats::Frequencies

pub struct Frequencies<T> { /* private fields */ }

A commutative data structure for exact frequency counts.

Implementations

impl<T: Eq + Hash> Frequencies<T>

pub fn new() -> Frequencies<T>

Create a new frequency table with no samples.

Examples found in repository

src/frequency.rs (line 131)

    fn from_iter<I: IntoIterator<Item = T>>(it: I) -> Frequencies<T> {
        let mut v = Frequencies::new();
        v.extend(it);
        v
    }

pub fn add(&mut self, v: T)

Add a sample to the frequency table.

Examples found in repository

src/frequency.rs (line 141)

    fn extend<I: IntoIterator<Item = T>>(&mut self, it: I) {
        for sample in it {
            self.add(sample);
        }
    }

pub fn count(&self, v: &T) -> u64

Return the number of occurrences of v in the data.

pub fn cardinality(&self) -> u64

Return the cardinality (number of unique elements) in the data.

pub fn mode(&self) -> Option<&T>

Returns the mode if one exists.

pub fn most_frequent(&self) -> Vec<(&T, u64)>

Return a Vec of elements and their corresponding counts in descending order.

Examples found in repository

src/frequency.rs (line 59)

    pub fn mode(&self) -> Option<&T> {
        let counts = self.most_frequent();
        if counts.is_empty() {
            return None;
        }
        if counts.len() >= 2 && counts[0].1 == counts[1].1 {
            None
        } else {
            Some(counts[0].0)
        }
    }

pub fn least_frequent(&self) -> Vec<(&T, u64)>

Return a Vec of elements and their corresponding counts in ascending order.

pub fn len(&self) -> usize

Returns the cardinality of the data.

Examples found in repository

src/frequency.rs (line 52)

    pub fn cardinality(&self) -> u64 {
        self.len() as u64
    }

pub fn is_empty(&self) -> bool

Returns true if there is no frequency/cardinality data.

Trait Implementations

impl<T: Clone> Clone for Frequencies<T>

fn clone(&self) -> Frequencies<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Eq + Hash> Commute for Frequencies<T>

fn merge(&mut self, v: Frequencies<T>)

Merges the value other into self.

fn consume<I: Iterator<Item = Self>>(&mut self, other: I)

Merges the values in the iterator into self.

impl<T: Debug + Eq + Hash> Debug for Frequencies<T>

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

Formats the value using the given formatter.

impl<T: Eq + Hash> Default for Frequencies<T>

fn default() -> Frequencies<T>

Returns the “default value” for a type.

impl<T: Eq + Hash> Extend<T> for Frequencies<T>

fn extend<I: IntoIterator<Item = T>>(&mut self, it: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<T: Eq + Hash> FromIterator<T> for Frequencies<T>

fn from_iter<I: IntoIterator<Item = T>>(it: I) -> Frequencies<T>

Creates a value from an iterator.