indicium 0.6.9

Simple in-memory search for collections and key-value stores.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

/// The `BatchComparator` trait allows `indicium` to treat the various distance
/// and string similarity algorithms in the
/// [rapidfuzz](https://crates.io/crates/rapidfuzz) crate generically.
///
/// This batch comparator trait provides a small, generic subset of the
/// `One × Many comparisons` provided by different algorithms in `rapidfuzz`.
pub trait BatchComparator {
    /// Instantiates a new batch comparator.
    #[must_use]
    fn new(one: &str) -> Self;

    /// Calculates normalized similarity.
    ///
    /// A `None` will be returned if the score is less than the specified
    /// cut-off.
    #[must_use]
    fn normalized_similarity(&self, many: &str, score_cutoff: f64) -> Option<f64>;
} // trait BatchComparator