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

//! Differentiator  
//!
//! A simple differentiator for use in cic filters.  

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

impl Differentiator {
    pub(crate) const fn new() -> Self {
        Self { last_input: 0 }
    }

    /// Differentiate the input and return the output.
    ///
    /// # Arguments
    ///
    /// * `input` - The input to differentiate.
    ///
    /// # Returns
    ///
    /// The output of the differentiator.
    #[inline]
    pub(crate) fn differentiate(&mut self, input: i32) -> i32 {
        let output = input.wrapping_sub(self.last_input);
        self.last_input = input;
        output
    }
}

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

    #[test]
    fn differentiate_test() {
        let mut differentiator = Differentiator::new();
        let result = differentiator.differentiate(2);
        assert_eq!(result, 2);
        let result = differentiator.differentiate(5);
        assert_eq!(result, 3);
        let result = differentiator.differentiate(-1);
        assert_eq!(result, -6);
    }
}