cic-fixed 0.5.1

CIC filter implementation for fixed point numbers
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

//! Decimator (downsampler) for cic decimation filter.  

/// Decimator
#[derive(Default, Clone, Copy)]
pub(crate) struct Decimator<const M: usize> {
    counter: usize,
}

impl<const M: usize> Decimator<M> {
    pub(crate) const fn new() -> Self {
        Self { counter: 0 }
    }

    /// Decimate the input and return the output.
    ///
    /// # Arguments
    ///
    /// * `input` - The input to decimate.
    ///
    /// # Returns
    ///
    /// The output of the decimator.  
    /// When the decimator is ready to output a value, it will return some(input). Otherwise, it will return None.  
    #[inline]
    pub(crate) fn decimate(&mut self, input: i32) -> Option<i32> {
        self.counter += 1;
        if self.counter == M {
            self.counter = 0;
            Some(input)
        } else {
            None
        }
    }
}

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

    #[test]
    fn decimator_test() {
        let mut decimator = Decimator::<4>::new();
        let result = decimator.decimate(1);
        assert!(result.is_none());
        let result = decimator.decimate(2);
        assert!(result.is_none());
        let result = decimator.decimate(3);
        assert!(result.is_none());
        let result = decimator.decimate(4);
        assert!(result.is_some());
        assert_eq!(result.unwrap(), 4);

        let result = decimator.decimate(5);
        assert!(result.is_none());
        let result = decimator.decimate(6);
        assert!(result.is_none());
        let result = decimator.decimate(7);
        assert!(result.is_none());
        let result = decimator.decimate(8);
        assert!(result.is_some());
        assert_eq!(result.unwrap(), 8);
    }
}