Struct fast_symspell::SymSpell[−][src]

pub struct SymSpell<T: StringStrategy> { /* fields omitted */ }

Implementations

impl<T: StringStrategy> SymSpell<T>[src]

pub fn load_dictionary(
    &mut self,
    corpus: &str,
    term_index: i64,
    count_index: i64,
    separator: &str
) -> bool[src]

Load multiple dictionary entries from a file of word/frequency count pairs.

Arguments

  • corpus - The path+filename of the file.
  • term_index - The column position of the word.
  • count_index - The column position of the frequency count.
  • separator - Separator between word and frequency

pub fn load_dictionary_line(
    &mut self,
    line: &str,
    term_index: i64,
    count_index: i64,
    separator: &str
) -> bool[src]

Load single dictionary entry from word/frequency count pair.

Arguments

  • line - word/frequency pair.
  • term_index - The column position of the word.
  • count_index - The column position of the frequency count.
  • separator - Separator between word and frequency

pub fn load_bigram_dictionary(
    &mut self,
    corpus: &str,
    term_index: i64,
    count_index: i64,
    separator: &str
) -> bool[src]

Load multiple bigram entries from a file of bigram/frequency count pairs.

Arguments

  • corpus - The path+filename of the file.
  • term_index - The column position of the word.
  • count_index - The column position of the frequency count.
  • separator - Separator between word and frequency

pub fn load_bigram_dictionary_line(
    &mut self,
    line: &str,
    term_index: i64,
    count_index: i64,
    separator: &str
) -> bool[src]

Load single dictionary entry from bigram/frequency count pair.

Arguments

  • line - bigram/frequency pair.
  • term_index - The column position of the word.
  • count_index - The column position of the frequency count.
  • separator - Separator between word and frequency

pub fn lookup(
    &self,
    input: &str,
    verbosity: Verbosity,
    max_edit_distance: i64
) -> Vec<Suggestion>[src]

Find suggested spellings for a given input word, using the maximum edit distance specified during construction of the SymSpell dictionary.

Arguments

  • input - The word being spell checked.
  • verbosity - The value controlling the quantity/closeness of the retuned suggestions.
  • max_edit_distance - The maximum edit distance between input and suggested words.

Examples

use symspell::{SymSpell, AsciiStringStrategy, Verbosity};

let mut symspell: SymSpell<AsciiStringStrategy> = SymSpell::default();
symspell.load_dictionary("data/frequency_dictionary_en_82_765.txt", 0, 1, " ");
symspell.lookup("whatver", Verbosity::Top, 2);

pub fn lookup_compound(
    &self,
    input: &str,
    edit_distance_max: i64
) -> Vec<Suggestion>[src]

Find suggested spellings for a given input sentence, using the maximum edit distance specified during construction of the SymSpell dictionary.

Arguments

  • input - The sentence being spell checked.
  • max_edit_distance - The maximum edit distance between input and suggested words.

Examples

use symspell::{SymSpell, AsciiStringStrategy};

let mut symspell: SymSpell<AsciiStringStrategy> = SymSpell::default();
symspell.load_dictionary("data/frequency_dictionary_en_82_765.txt", 0, 1, " ");
symspell.lookup_compound("whereis th elove", 2);

pub fn word_segmentation(
    &self,
    input: &str,
    max_edit_distance: i64
) -> Composition[src]

Divides a string into words by inserting missing spaces at the appropriate positions

Arguments

  • input - The word being segmented.
  • max_edit_distance - The maximum edit distance between input and suggested words.

Examples

use symspell::{SymSpell, UnicodeStringStrategy, Verbosity};

let mut symspell: SymSpell<UnicodeStringStrategy> = SymSpell::default();
symspell.load_dictionary("data/frequency_dictionary_en_82_765.txt", 0, 1, " ");
symspell.word_segmentation("itwas", 2);

Trait Implementations

impl<T: StringStrategy> Default for SymSpell<T>[src]

impl<T: PartialEq + StringStrategy> PartialEq<SymSpell<T>> for SymSpell<T>[src]

impl<T: StringStrategy> StructuralPartialEq for SymSpell<T>[src]

Auto Trait Implementations

impl<T> RefUnwindSafe for SymSpell<T> where
    T: RefUnwindSafe, 

impl<T> Send for SymSpell<T> where
    T: Send, 

impl<T> Sync for SymSpell<T> where
    T: Sync, 

impl<T> Unpin for SymSpell<T> where
    T: Unpin, 

impl<T> UnwindSafe for SymSpell<T> where
    T: UnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.