Checks if a search conducted for
search_term should match
This function calls tokenize_and_fold on both
potential_hit. ASCII alternates are never taken for
search_term but will be taken for
according to the value of
A hit occurs when each folded token in
search_term is a prefix of a folded token from
Depending on how you're performing the search, it will typically be faster to call tokenize_and_fold on each string in your corpus and build an index on the returned folded tokens, then call tokenize_and_fold on the search term and perform lookups into that index.
As some examples, searching for ‘fred’ would match the potential hit ‘Smith, Fred’ and also ‘Frédéric’. Searching for ‘Fréd’ would match ‘Frédéric’ but not ‘Frederic’ (due to the one-directional nature of accent matching). Searching ‘fo’ would match ‘Foo’ and ‘Bar Foo Baz’, but not ‘SFO’ (because no word has ‘fo’ as a prefix).
the search term from the user
true to accept ASCII alternates
the text that may be a hit