ic-bn-lib 0.1.19

Internet Computer Boundary Nodes shared modules
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

/// Implementation of Exponential Weighted Moving Average.
/// https://en.wikipedia.org/wiki/Exponential_smoothing#Basic_(simple)_exponential_smoothing
#[derive(Debug)]
pub struct EWMA {
    alpha: f64,
    new: bool,
    value: f64,
}

impl EWMA {
    /// Create new `EWMA`
    pub fn new(alpha: f64) -> Self {
        assert!((0.0..=1.0).contains(&alpha));

        Self {
            new: true,
            value: 0.0,
            alpha,
        }
    }

    /// Record new measurement
    pub fn add(&mut self, v: f64) {
        if self.new {
            self.new = false;
            self.value = v;
            return;
        }

        // Use FMA instruction for faster and more precise calculation of a*b + c
        self.value = self.alpha.mul_add(v - self.value, self.value)
    }

    /// Get the average
    pub const fn get(&self) -> Option<f64> {
        if self.new {
            return None;
        }

        Some(self.value)
    }
}

/// Implementation of Double Exponential Weighted Moving Average.
/// https://en.wikipedia.org/wiki/Exponential_smoothing#Double_exponential_smoothing_(Holt_linear)
#[derive(Debug)]
pub struct DEWMA {
    alpha: f64,
    beta: f64,

    iter: u8,
    value: f64,
    trend: f64,
}

impl DEWMA {
    /// Create new `DEWMA`
    pub fn new(alpha: f64, beta: f64) -> Self {
        assert!((0.0..=1.0).contains(&alpha));
        assert!((0.0..=1.0).contains(&beta));

        Self {
            iter: 0,
            value: 0.0,
            trend: 0.0,
            alpha,
            beta,
        }
    }

    /// Add a measurement
    pub fn add(&mut self, v: f64) {
        if self.iter == 0 {
            self.iter += 1;
            self.value = v;
            return;
        } else if self.iter == 1 {
            // Initialize the trend on 2nd measurement
            self.iter += 1;
            self.trend = v - self.value;
        }

        let value_old = self.value;

        // Use FMA instruction for faster and more precise calculation of a*b + c
        self.value = self
            .alpha
            .mul_add(v, (1.0 - self.alpha) * (self.value + self.trend));
        self.trend = self
            .beta
            .mul_add(self.value - value_old, (1.0 - self.beta) * self.trend);
    }

    /// Get the average
    pub fn get(&self, m: f64) -> Option<f64> {
        // The function is undefined for the 1st measurement
        if self.iter < 2 {
            return None;
        }

        Some(m.mul_add(self.trend, self.value))
    }
}

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

    #[test]
    fn test_ewma() {
        let mut e = EWMA::new(0.7);

        assert!(e.get().is_none());
        e.add(100.0);
        assert_eq!(e.get().unwrap(), 100.0);
        e.add(150.0);
        assert_eq!(e.get().unwrap(), 135.0);
        e.add(150.0);
        assert_eq!(e.get().unwrap(), 145.5);
        e.add(150.0);
        assert_eq!(e.get().unwrap(), 148.65);
    }

    #[test]
    fn test_dewma() {
        let mut e = DEWMA::new(0.7, 0.6);

        e.add(100.0);
        assert!(e.get(0.0).is_none());
        e.add(150.0);
        assert_eq!(e.get(0.0).unwrap(), 150.0);
        e.add(200.0);
        assert_eq!(e.get(0.0).unwrap(), 200.0);
        e.add(300.0);
        assert_eq!(e.get(0.0).unwrap(), 285.0);
        assert_eq!(e.get(1.0).unwrap(), 356.0);
        e.add(300.0);
        assert_eq!(e.get(0.0).unwrap(), 316.8);
    }
}