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

//! Integrator  
//!
//! Simple integrator for cic filter.

/// Integrator
#[derive(Default, Clone, Copy)]
pub(crate) struct Integrator {
    last_output: i32,
}

impl Integrator {
    pub(crate) const fn new() -> Self {
        Self { last_output: 0 }
    }

    /// Integrate the input and return the output.
    ///
    /// # Arguments
    ///
    /// * `input` - The input to integrate.
    ///
    /// # Returns
    ///
    /// The output of the integrator.    
    #[inline]
    pub(crate) fn integrate(&mut self, input: i32) -> i32 {
        let output = self.last_output.wrapping_add(input);
        self.last_output = output;
        output
    }
}

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

    #[test]
    fn integrate_test() {
        let mut integrator = Integrator::new();
        let result = integrator.integrate(2);
        assert_eq!(result, 2);
        let result = integrator.integrate(5);
        assert_eq!(result, 7);
        let result = integrator.integrate(10);
        assert_eq!(result, 17);
        let result = integrator.integrate(-20);
        assert_eq!(result, -3);
        let result = integrator.integrate(8);
        assert_eq!(result, 5);
    }
}