Struct cic_fixed::CicDecimationFilter

pub struct CicDecimationFilter<const M: usize, const N: usize> { /* private fields */ }

CIC decimation filter.

• M - Decimation factor
• N - Number of stages

Implementations

impl<const M: usize, const N: usize> CicDecimationFilter<M, N>

pub const fn new() -> Self

pub fn filter(&mut self, input: i32) -> Option<i32>

Process the input and return the output when the decimator is ready to output a value.

Arguments

• input - The input to filter.

Returns

The output of the filter.
The output range is Input range * (M^N). For example, if Input range is +/-1, M is 4, and N is 2, the output range is +/-16.
When the decimator is ready to output a value, it will return some(input). Otherwise, it will return None.

Trait Implementations

impl<const M: usize, const N: usize> Default for CicDecimationFilter<M, N>

fn default() -> Self

Returns the “default value” for a type.