clustr 0.1.2

Multithreaded string clustering
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use super::merge_clusters;

use crossbeam;
use fast_math::log2_raw;
use std::sync::{Arc, Mutex};

pub fn aggregate_results<'a>(
    results: Vec<Vec<Vec<&'a str>>>,
    max_edit_frac: f32,
) -> Vec<Vec<&'a str>> {
    let mut results = Arc::new(results);
    let n_aggregations = log2_raw(results.len() as f32).ceil() as usize;

    let aggregations = Arc::new(Mutex::new(Vec::new()));

    for _ in 0..n_aggregations {
        crossbeam::scope(|s| {
            for j in (0..results.len()).step_by(2) {
                let results = Arc::clone(&results);
                let aggregations = Arc::clone(&aggregations);

                s.spawn(move |_| {
                    let x = &mut results[j].clone();

                    if j + 1 == results.len() {
                        // Pass result to next level
                        aggregations.lock().unwrap().push(results[j].clone());
                    } else {
                        // Merge clusters
                        let y = &mut results[j + 1].clone();
                        let agg = merge_clusters(x, y, max_edit_frac);
                        aggregations.lock().unwrap().push(agg);
                    }
                });
            }
        })
        .unwrap();

        results = Arc::new(aggregations.lock().unwrap().clone());
        aggregations.lock().unwrap().clear();
    }
    return results.to_vec()[0].clone();
}

#[cfg(test)]
mod tests {
    use super::aggregate_results;

    #[test]
    fn test_one_merge() {
        let input = vec![vec![vec!["aa"], vec!["bb"]], vec![vec!["aa"], vec!["bb"]]];
        let expected = vec![vec!["aa", "aa"], vec!["bb", "bb"]];
        let results = aggregate_results(input, 0.0);
        for e in expected {
            assert!(results.contains(&e));
        }
    }

    #[test]
    fn test_three_merge() {
        let input = vec![
            vec![vec!["aa"]],
            vec![vec!["bb"]],
            vec![vec!["aa"]],
            vec![vec!["bb"]],
        ];
        let expected = vec![vec!["aa", "aa"], vec!["bb", "bb"]];
        let results = aggregate_results(input, 0.0);
        for e in expected {
            assert!(results.contains(&e));
        }
    }

    #[test]
    fn test_two_merge_one_pass() {
        let input = vec![vec![vec!["aa"]], vec![vec!["bb"]], vec![vec!["aa"]]];
        let expected = vec![vec!["aa", "aa"], vec!["bb"]];
        let results = aggregate_results(input, 0.0);
        for e in expected {
            assert!(results.contains(&e));
        }
    }

    #[test]
    fn test_six_merge_one_pass() {
        let input = vec![
            vec![vec!["aa"]],
            vec![vec!["bb"]],
            vec![vec!["aa"]],
            vec![vec!["bb"]],
            vec![vec!["aa"]],
            vec![vec!["bb"]],
            vec![vec!["aa"]],
        ];
        let expected = vec![vec!["aa", "aa", "aa", "aa"], vec!["bb", "bb", "bb"]];
        let results = aggregate_results(input, 0.0);
        for e in expected {
            assert!(results.contains(&e));
        }
    }

    #[test]
    fn test_two_merge_multiple_element_clusters() {
        let input = vec![
            vec![vec!["aaa", "aaa"], vec!["bbb", "bbb"], vec!["ccc", "ccc"]],
            vec![vec!["aaa", "aaa"], vec!["bbb", "bbb"], vec!["ccc", "ccc"]],
            vec![vec!["aaa", "aaa"], vec!["bbb", "bbb"], vec!["ccc", "ccc"]],
        ];
        let expected = vec![
            vec!["aaa", "aaa", "aaa", "aaa", "aaa", "aaa"],
            vec!["bbb", "bbb", "bbb", "bbb", "bbb", "bbb"],
            vec!["ccc", "ccc", "ccc", "ccc", "ccc", "ccc"],
        ];
        let results = aggregate_results(input, 0.0);
        for e in expected {
            assert!(results.contains(&e));
        }
    }

    #[test]
    fn test_non_zero_max_edit_frac_one_merge() {
        let input = vec![
            vec![vec!["aaaa", "aaaa"], vec!["bbbb", "bbbb"]],
            vec![vec!["aaax", "aaax"], vec!["bbbz", "bbbz"]],
        ];
        let expected = vec![
            vec!["aaaa", "aaaa", "aaax", "aaax"],
            vec!["bbbb", "bbbb", "bbbz", "bbbz"],
        ];
        let results = aggregate_results(input, 0.25);
        for e in expected {
            assert!(results.contains(&e));
        }
    }

    #[test]
    fn test_no_merge() {
        let input = vec![vec![vec!["aa", "aa"]]];
        let expected = vec![vec!["aa", "aa"]];
        let results = aggregate_results(input, 0.0);
        assert_eq!(results, expected);
    }
}