textdistance 1.1.1

Lots of algorithms to compare how similar two sequences are
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
64

//! Yujian-Bo distance
use super::levenshtein::Levenshtein;
use crate::{Algorithm, Result};

/// [Yujian-Bo distance] is a normalization of [`Levenshtein`].
///
/// [Yujian-Bo distance]: https://ieeexplore.ieee.org/document/4160958
#[derive(Default)]
pub struct YujianBo {
    /// Algorithm instance to use for calculating Levenshtein distance.
    pub levenshtein: Levenshtein,
}

impl Algorithm<f64> for YujianBo {
    fn for_iter<C, E>(&self, s1: C, s2: C) -> Result<f64>
    where
        C: Iterator<Item = E>,
        E: Eq + core::hash::Hash,
    {
        let lev = self.levenshtein.for_iter(s1, s2);
        let dc: usize = self.levenshtein.del_cost;
        let ic: usize = self.levenshtein.ins_cost;
        let lval = lev.val();
        let res = if lval == 0 {
            0.0
        } else {
            (2 * lval) as f64 / (lev.len1 * dc + lev.len2 * ic + lval) as f64
        };
        Result {
            abs: res,
            is_distance: true,
            max: 1.0,
            len1: lev.len1,
            len2: lev.len2,
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::str::yujian_bo;
    use assert2::assert;
    use rstest::rstest;

    fn is_close(a: f64, b: f64) -> bool {
        (a - b).abs() < 1E-5
    }

    #[rstest]
    #[case("", "", 0.0)]
    // parity with abydos
    #[case("a", "", 1.0)]
    #[case("", "a", 1.0)]
    #[case("bc", "", 1.0)]
    #[case("", "bc", 1.0)]
    #[case("bc", "bc", 0.0)]
    #[case("bcd", "fgh", 0.6666666666666666)]
    #[case("ATCG", "TAGC", 0.5454545454545454)]
    #[case("cat", "hat", 0.285714285714)]
    #[case("aluminum", "Catalan", 0.6363636363636364)]
    fn function_str(#[case] s1: &str, #[case] s2: &str, #[case] exp: f64) {
        assert!(is_close(yujian_bo(s1, s2), exp));
    }
}