moving_avg 0.2.0

Moving average filter
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

//! Moving average filter.

extern crate num_traits;

use num_traits::{Float, NumCast};

/// Computes a moving average over a ring buffer of numbers.
pub struct MovingAverage<T> {
    /// Current history of numbers.
    hist: Vec<T>,
    /// Size of the history, as T.
    size: T,
    /// Index in the history vector to replace next.
    pos: usize,
}

impl<T: Float + NumCast> MovingAverage<T> {
    /// Create a new `MovingAverage` that averages over the given amount of numbers.
    pub fn new(size: usize) -> Self {
        MovingAverage {
            hist: vec![T::zero(); size],
            size: T::from(size).unwrap(),
            pos: 0,
        }
    }

    /// Add the given number to the history, overwriting the oldest number, and return the
    /// resulting moving average.
    pub fn feed(&mut self, num: T) -> T {
        self.hist[self.pos] = num;

        self.pos += 1;
        self.pos %= self.hist.len();

        self.avg()
    }

    /// Calculate moving average based on the current history.
    fn avg(&self) -> T {
        self.hist.iter().fold(T::zero(), |s, &x| s + x) / self.size
    }
}

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

    #[test]
    fn test_ma() {
        let mut ma = MovingAverage::<f32>::new(10);
        assert_eq!(ma.feed(1.0), 0.1);
        assert_eq!(ma.feed(1.0), 0.2);
        assert_eq!(ma.feed(1.0), 0.3);
        assert_eq!(ma.feed(1.0), 0.4);
        assert_eq!(ma.feed(1.0), 0.5);
        assert_eq!(ma.feed(1.0), 0.6);
        assert_eq!(ma.feed(1.0), 0.7);
        assert_eq!(ma.feed(1.0), 0.8);
        assert_eq!(ma.feed(1.0), 0.9);
        assert_eq!(ma.feed(1.0), 1.0);
        assert_eq!(ma.feed(0.0), 0.9);
        assert_eq!(ma.feed(0.0), 0.8);
        assert_eq!(ma.feed(0.0), 0.7);
        assert_eq!(ma.feed(0.0), 0.6);
        assert_eq!(ma.feed(0.0), 0.5);
        assert_eq!(ma.feed(0.0), 0.4);
        assert_eq!(ma.feed(0.0), 0.3);
        assert_eq!(ma.feed(0.0), 0.2);
        assert_eq!(ma.feed(0.0), 0.1);
        assert_eq!(ma.feed(0.0), 0.0);
    }
}