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
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! Jaro-Winkler similarity

#![allow(clippy::inline_always)]

use rapidfuzz::distance::jaro_winkler::{Args, BatchComparator};

/// This `struct` is used to access the Jaro-Winkler algorithm, as implemented
/// by the [rapidfuzz](https://crates.io/crates/rapidfuzz) crate, in a generic
/// manner.
///
/// The Jaro-Winkler similarity extends the Jaro similarity to provide
/// additional sensitivity to matching prefixes. It introduces a scaling
/// mechanism that boosts the similarity score for strings with common prefixes.
pub struct JaroWinkler(BatchComparator<char>);

/// This `BatchComparator` trait implementation is used to access the
/// Jaro-Winkler algorithm, as implemented by the
/// [rapidfuzz](https://crates.io/crates/rapidfuzz) crate, in a generic manner.
impl crate::simple::internal::fuzzers::rapidfuzz::BatchComparator for JaroWinkler {
    /// Instantiates a new batch comparator.
    #[inline(always)]
    fn new(one: &str) -> Self {
        Self(BatchComparator::new(one.chars()))
    } // fn

    /// Calculates normalized similarity.
    #[inline(always)]
    fn normalized_similarity(
        &self,
        many: &str,
        score_cutoff: f64
    ) -> Option<f64> {
        self.0.normalized_similarity_with_args(
            many.chars(),
            &Args::default().score_cutoff(score_cutoff)
        )
    } // fn
} // impl