Struct SimpleSearch 

pub struct SimpleSearch {
    pub algorithm: Algorithm,
    pub distance: fn(&str, &str) -> f64,
    pub max_edits: Option<i32>,
    pub similarity_threshold: Option<f64>,
    pub targets: Vec<String>,
}

A struct to hold the input into a Simple Search.

Simple Search focuses on comparing strings which could be anything provided by the user.

Simple Search uses SimpleSearch and SimpleResult to hold the input and output data.

Fields

algorithm: Algorithm

The Algorithm to use.

distance: fn(&str, &str) -> f64

The distance function to use, based on the Algorithm selected.

max_edits: Option<i32>

The maximum number of edits allowed.

This can be None if the user does not want to limit the results based on the number of edits.

This should be None if the Algorithm is not an edit distance.

similarity_threshold: Option<f64>

The minimum similarity score required.

This can be None if the user does not want to limit the results based on the similarity score.

targets: Vec<String>

The target search words in the format of a vector of strings.

Implementations

impl SimpleSearch

pub fn new( algorithm: Algorithm, distance: fn(&str, &str) -> f64, max_edits: Option<i32>, similarity_threshold: Option<f64>, targets: &[String], ) -> SimpleSearch

Create a new SimpleSearch struct.

Trait Implementations

impl Search for SimpleSearch

fn scan( &self, text: &str, record: Option<String>, state: &mut Option<HashMap<(String, String), f64>>, ) -> Vec<SearchOutput>

Scanning function to find matches.

Searches the input text for the target words. This also does some pre-processing to remove punctuation and other non-alphanumeric characters as well as upper-casing the input text.

The search will be limited by the number of edits and/or similarity threshold (if) provided in the SimpleSearch struct.

The results will be returned as a vector of SimpleResult structs.

Examples

TODO: Add examples

let search = SimpleSearch::new(Algorithm::Levenshtein, levenshtein, None, None, &["hello", "world"]);
let results = search.scan("hello world", None);