classify 0.2.2

A collection of algorithms for categorizing 1D data
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
144
145
146
147
148
149
150
151
152
153

mod jenks;
pub use jenks::{get_jenks_breaks, get_jenks_classification};

mod quantile;
pub use quantile::{get_quantile_breaks, get_quantile_classification};

mod head_tail;
pub use head_tail::{get_head_tail_breaks, get_head_tail_classification};

mod equal_interval;
pub use equal_interval::{get_equal_interval_breaks, get_equal_interval_classification};

mod standard_deviation;
pub use standard_deviation::{get_st_dev_breaks, get_st_dev_classification};

mod hinge;
pub use hinge::{get_hinge_breaks, get_hinge_classification};

mod utilities;
pub use utilities::{breaks_to_classification, classify_val};
pub use utilities::{Bin, Classification};

#[cfg(target_family = "wasm")]
mod wasm;

#[cfg(test)]
mod tests {
    use crate::utilities::{to_vec_f64, UniqueVal};
    use crate::*;
    use rand::prelude::*;
    use rand::rngs::StdRng;

    #[test]
    fn test_to_vec_f64() {
        let data: Vec<usize> = vec![0, 1, 2, 3];
        let data = to_vec_f64(&data);
        let expected: Vec<f64> = vec![0.0, 1.0, 2.0, 3.0];

        assert_eq!(data, expected);
    }

    #[test]
    fn test_percentile() {
        let data: Vec<usize> = vec![0, 1, 2, 3, 4, 5, 6, 7, 8];
        let data = to_vec_f64(&data);
        let percs = vec![10, 25, 50, 75, 90];
        let mut result = vec![];
        for perc in percs {
            result.push(hinge::percentile(perc, &data));
        }
        let expected = vec![0.8, 2.0, 4.0, 6.0, 7.2];

        assert_eq!(result, expected);
    }

    #[test]
    fn test_create_unique_val_mapping() {
        let mut unique_val_map: Vec<UniqueVal> = vec![];
        let data: Vec<f64> = vec![2.0, 2.0, 7.0, 7.0, 7.0, 8.0];

        utilities::create_unique_val_mapping(&mut unique_val_map, &data);

        let expected = vec![
            UniqueVal {
                val: 2.0,
                first: 0,
                last: 1,
            },
            UniqueVal {
                val: 7.0,
                first: 2,
                last: 4,
            },
            UniqueVal {
                val: 8.0,
                first: 5,
                last: 5,
            },
        ];

        for i in 0..unique_val_map.len() {
            let value = &unique_val_map[i];
            let check = &expected[i];
            assert_eq!(
                value.val, check.val,
                "create_unique_val_mapping not working!"
            );
            assert_eq!(
                value.first, check.first,
                "create_unique_val_mapping not working!"
            );
            assert_eq!(
                value.last, check.last,
                "create_unique_val_mapping not working!"
            );
        }
    }

    #[test]
    fn test_unique_to_normal_breaks() {
        let mut unique_val_map: Vec<UniqueVal> = vec![];
        let data: Vec<f64> = vec![1.0, 2.0, 2.0, 4.0, 5.0, 7.0, 7.0, 7.0, 8.0];
        utilities::create_unique_val_mapping(&mut unique_val_map, &data);
        let unique_val_breaks: Vec<usize> = vec![1, 3, 4];
        let mut normal_breaks: Vec<usize> = vec![0; unique_val_breaks.len()];

        utilities::unique_to_normal_breaks(&unique_val_breaks, &unique_val_map, &mut normal_breaks);

        assert_eq!(
            normal_breaks,
            vec![1, 4, 5],
            "unique_to_normal_breaks not working!"
        );
    }

    #[test]
    fn test_pick_rand_breaks() {
        let num_bins = 3;
        let mut breaks: Vec<usize> = vec![0; num_bins - 1];
        let data: Vec<f64> = vec![1.0, 2.0, 4.0, 5.0, 7.0, 8.0, 10.0, 11.0];
        let num_vals = data.len();
        let mut rng = StdRng::seed_from_u64(123456789);

        jenks::pick_rand_breaks(&mut breaks, &num_vals, &mut rng);

        assert_eq!(breaks, vec![3, 7], "pick_rand_breaks not working!");
    }

    #[test]
    fn test_calc_gvf() {
        let mut unique_val_map: Vec<UniqueVal> = vec![];
        let data: Vec<f64> = vec![1.0, 2.0, 4.0, 5.0, 7.0, 8.0];
        utilities::create_unique_val_mapping(&mut unique_val_map, &data);
        let breaks: Vec<usize> = vec![1, 3, 4];
        let gssd: f64 = jenks::calc_gssd(&data);

        assert_eq!(jenks::calc_gvf(&breaks, &data, &gssd), 0.9333333333333333);
    }

    #[test]
    fn test_calc_gssd() {
        let data: Vec<f64> = vec![1.0, 2.0, 4.0, 5.0, 7.0, 8.0];

        assert_eq!(jenks::calc_gssd(&data), 37.5);
    }

    #[test]
    fn test_calc_st_dev() {
        let data: Vec<f64> = vec![0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0];

        assert_eq!(standard_deviation::calc_st_dev(&data), 1.0801234497346435);
    }
}