Struct Ngrams 

pub struct Ngrams { /* private fields */ }

An n-gram counter for counting n-gram frequencies.

Accumulates n-gram counts from sequences of elements. N-grams do not cross sequence boundaries.

For Python, use [PyNgrams].

Implementations

impl Ngrams

pub fn new(n: usize, min_n: Option<usize>) -> Result<Self, ModelError>

Create a new empty Ngrams.

Arguments

• n - The n-gram order (1 for unigrams, 2 for bigrams, etc.). Must be >= 1.
• min_n - Minimum n-gram order. Must be >= 1 and <= n. Defaults to n.

Trait Implementations

impl BaseNgrams for Ngrams

fn order(&self) -> usize

fn min_order(&self) -> usize

fn counts(&self) -> &CountTrie<String>

fn counts_mut(&mut self) -> &mut CountTrie<String>

fn totals(&self) -> &Vec<u64>

fn totals_mut(&mut self) -> &mut Vec<u64>

fn from_parts( order: usize, min_order: usize, counts: CountTrie<String>, totals: Vec<u64>, ) -> Self

fn count(&mut self, seq: Vec<String>)

Count n-grams from a single sequence.

fn count_seqs(&mut self, seqs: Vec<Vec<String>>)

Count n-grams from multiple sequences.

fn get(&self, ngram: Vec<String>) -> u64

Return the count for a specific n-gram.

fn validate_order(&self, order: Option<usize>) -> Result<(), ModelError>

Validate that an order is within the valid range.

fn most_common_items( &self, n: Option<usize>, order: Option<usize>, ) -> Result<Vec<(Vec<String>, u64)>, ModelError>

Return the n most common n-grams with their counts.

fn items_list( &self, order: Option<usize>, ) -> Result<Vec<(Vec<String>, u64)>, ModelError>

Return all (n-gram, count) pairs.

fn total(&self, order: Option<usize>) -> Result<u64, ModelError>

Return the total number of n-gram tokens counted.

fn len(&self) -> usize

Number of unique n-grams.

fn is_empty(&self) -> bool

Whether no n-grams have been counted.

fn contains(&self, ngram: Vec<String>) -> bool

Whether a specific n-gram has been observed.

fn all_ngrams(&self) -> Vec<Vec<String>>

Return all n-grams (without counts).

fn repr_string(&self) -> String

Return a string representation.

fn add(&self, other: &Self) -> Result<Self, ModelError>

Add two n-gram counters together, returning a new counter.

fn iadd(&mut self, other: &Self) -> Result<(), ModelError>

Add another n-gram counter into this one in-place.

fn clear(&mut self)

Clear all counts.

impl Clone for Ngrams

fn clone(&self) -> Ngrams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ngrams

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

Formats the value using the given formatter.