numeric-statistics 0.3.0

Numeric Statistics: functions for min, max, average, variance, standard deviation, and more to come.
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

use super::average;

/// Calculate statistical variance for values.
///
/// Return NaN if the values are empty.
///
/// Filter NaN values in the stream.
///
/// # Example
///
/// ```rust
/// #[macro_use]
/// use numeric_statistics::assert_eq_f32;
/// use numeric_statistics::f32::variance::*;
/// let values = &[1.0, 2.0, 4.0];
/// let variance = variance(values);
/// assert_eq_f32!(variance, 2.3333333 as f32);
/// ```
/// 
pub fn variance<T: AsRef<[f32]>>(values: T) -> f32 {
    let values = values.as_ref();
    if values.is_empty() { return f32::NAN; }
    let average = average(values);
    variance_with_average(values, average)
}

/// Calculate statistical variance for values, 
/// given a pre-calculated average value.
///
/// Return NaN if the values are empty.
///
/// Filter NaN values in the stream.
/// 
/// # Example
///
/// ```rust
/// #[macro_use]
/// use numeric_statistics::assert_eq_f32;
/// use numeric_statistics::f32::{average::*, variance::*};
/// let values = &[1.0, 2.0, 4.0];
/// let average = average(values);
/// let variance = variance_with_average(values, average);
/// assert_eq_f32!(variance, 2.3333333 as f32);
/// ```
/// 
pub fn variance_with_average<T: AsRef<[f32]>>(values: T, average: f32) -> f32 {
    let values = values.as_ref();
    if values.is_empty() { return f32::NAN; }
    let mut delta_square_sum: f32 = 0.0;
    let mut len: usize = 0;
    values.iter().for_each(|x|
        if !x.is_nan() {
            let delta = x - average;
            delta_square_sum += delta * delta;
            len += 1;
        }
    );
    match len {
        0 => return f32::NAN,
        1 => return 0.0,
        x => delta_square_sum / ((x - 1) as f32)
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::assert_eq_f32;

    #[test]
    fn test_empty() {
        let x: &[f32] = &[];
        assert!(variance(x).is_nan());
    }

    #[test]
    fn test_nan() {
        let x: &[f32] = &[f32::NAN];
        assert!(variance(x).is_nan());
    }

    #[test]
    fn test_value() {
        let x: &[f32] = &[1.0];
        assert_eq_f32!(variance(x), 0.0);
    }

    #[test]
    fn test_values_ascending() {
        let x = &[1.0, 2.0, 4.0];
        assert_eq_f32!(variance(x), 2.3333333333333333 as f32);
    }

    #[test]
    fn test_values_ascending_and_nans() {
        let x = &[1.0, f32::NAN, 2.0, f32::NAN, 4.0];
        assert_eq_f32!(variance(x), 2.3333333333333333 as f32);
    }

}