fuzzt 0.3.1

Implementations of string similarity metrics. Includes Hamming, Levenshtein, OSA, Damerau-Levenshtein, Jaro, Jaro-Winkler, and Sørensen-Dice.
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

#[macro_export]
macro_rules! assert_delta {
    ($x:expr, $y:expr) => {
        assert_delta!($x, $y, 1e-5);
    };
    ($x:expr, $y:expr, $d:expr) => {
        if ($x - $y).abs() > $d {
            panic!(
                "assertion failed: actual: `{}`, expected: `{}`: \
                    actual not within < {} of expected",
                $x, $y, $d
            );
        }
    };
}

#[cfg(feature = "damerau_levenshtein")]
pub mod damerau_levenshtein;
#[cfg(feature = "damerau_levenshtein")]
pub use damerau_levenshtein::{
    damerau_levenshtein, generic_damerau_levenshtein, normalized_damerau_levenshtein,
    DamerauLevenshtein, NormalizedDamerauLevenshtein,
};

pub mod gestalt;
pub use gestalt::{sequence_matcher, SequenceMatcher};

#[cfg(feature = "hamming")]
pub mod hamming;
#[cfg(feature = "hamming")]
pub use hamming::{hamming, Hamming};

#[cfg(feature = "jaro")]
pub mod jaro;
#[cfg(feature = "jaro")]
pub use jaro::{jaro, jaro_winkler, Jaro, JaroWinkler};

#[cfg(feature = "levenshtein")]
pub mod levenshtein;
#[cfg(feature = "levenshtein")]
pub use levenshtein::{
    generic_levenshtein, levenshtein, normalized_levenshtein, Levenshtein, NormalizedLevenshtein,
};

#[cfg(feature = "optimal_string_alignment")]
pub mod optimal_string_alignment;
#[cfg(feature = "optimal_string_alignment")]
pub use optimal_string_alignment::{osa_distance, OSADistance};

#[cfg(feature = "sorensen_dice")]
pub mod sorensen_dice;
#[cfg(feature = "sorensen_dice")]
pub use sorensen_dice::{sorensen_dice, SorensenDice};

pub enum Similarity {
    Usize(usize),
    Float(f64),
}

pub trait SimilarityMetric {
    // The smaller, the more similar 2 strings are.
    fn compute_metric(&self, a: &str, b: &str) -> Similarity;
}