Module proximity

Word similarity for typo tolerance and matching beginning of words.

Modules

• algo
  String similarity algorithms.

Structs

• ProximateDocItem
  An item found by ProximateDocIter, an occurrence of ProximateWordItem in any of the documents in the Provider passed to proximate_word_docs.
• ProximateDocIter
  See proximate_word_docs.
• ProximateList
  A list of words close to the target word, and their “rating”.
• ProximateMap
  Map of words to their ProximateList.
• ProximateWordItem
  An item of the ProximateWordIter, returned from proximate_words.
• ProximateWordIter
  An iterator over the words with high likeness to the target word, as provided when running proximate_words.

Enums

• Algorithm
  The string proximity algorithm to use.

Functions

• proximate_word_docs
  Search for words in provider.
• proximate_words
  If threshold is closer to 0, more results are accepted. It has a range of [0..1]. E.g. 0.95 means word is probably the only word to match.