Struct ngrammatic::Ngram

pub struct Ngram {
    pub arity: usize,
    pub text: String,
    pub text_padded: String,
    pub grams: HashMap<String, usize>,
}

Stores a “word”, with all its n-grams. The “arity” member determines the value of “n” used in generating the n-grams.

Fields

arity: usize

The “symbol size” for the ngrams

text: String

The text for which ngrams were generated

text_padded: String

The text for which ngrams were generated, with the padding used for generating the ngrams

grams: HashMap<String, usize>

A collection of all generated ngrams for the text, with a count of how many times that ngram appears in the text

Implementations

impl Ngram

pub fn similarity_to(&self, other: &Ngram, warp: f32) -> f32

Calculate the similarity of this Ngram and an other, for a given warp factor (clamped to the range 1.0 to 3.0).

let a = NgramBuilder::new("tomato").finish();
let b = NgramBuilder::new("tomacco").finish();
println!("Similarity factor for {} and {}: {:.0}%", a.text, b.text, a.similarity_to(&b, 2.0) *
100.0);

pub fn matches(&self, other: &Ngram, threshold: f32) -> Option<SearchResult>

Determines if this Ngram matches a given other Ngram, for a given threshold of certainty. This is equivalent to matches_with_warp and a warp of 2.0.

let a = NgramBuilder::new("tomato").finish();
let b = NgramBuilder::new("tomacco").finish();
if let Some(word_match) = a.matches(&b, 0.40) {
    println!("{} matches {} with {:.0}% certainty", a.text, b.text, word_match.similarity *
    100.0);
} else {
    println!("{} doesn't look anything like {}.", a.text, b.text);
}

pub fn matches_with_warp(
    &self,
    other: &Ngram,
    warp: f32,
    threshold: f32
) -> Option<SearchResult>

Determines if this Ngram matches a given other Ngram, with the specified warp (clamped to the range 1.0 to 3.0), and for a given threshold of certainty.

let a = NgramBuilder::new("tomato").finish();
let b = NgramBuilder::new("tomacco").finish();
if let Some(word_match) = a.matches_with_warp(&b, 2.0, 0.40) {
    println!("{} matches {} with {:.0}% certainty", a.text, b.text, word_match.similarity *
    100.0);
} else {
    println!("{} doesn't look anything like {}.", a.text, b.text);
}

pub fn count_gram(&self, gram: &str) -> usize

Return the number of times a particular gram appears in the Ngram text.

let a = NgramBuilder::new("tomato").arity(2).finish();
println!("Number of times the 'to' bigram appears in {}: {}", a.text, a.count_gram("to"));

pub fn count_grams(&self) -> usize

Return the total number of grams generated for the Ngram text.

pub fn contains(&self, gram: &str) -> bool

If the set of grams contains the specified gram.

let a = NgramBuilder::new("tomato").arity(2).finish();
if a.contains("to") {
    println!("{} contains the bigram 'to'!", a.text);
}

Trait Implementations

impl Clone for Ngram

fn clone(&self) -> Ngram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ngram

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

Formats the value using the given formatter.

impl Default for Ngram

fn default() -> Ngram

Returns the “default value” for a type.

impl Hash for Ngram

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Ngram> for Ngram

fn eq(&self, other: &Self) -> 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 !=.

impl Eq for Ngram