Struct Cic

pub struct Cic<T, const N: usize> { /* private fields */ }

Cascaded integrator comb structure

Order N where N = 3 is cubic.

Implementations

impl<T, const N: usize> Cic<T, N>

where T: Num + AddAssign + WrappingAdd + WrappingSub + Pow<usize, Output = T> + Copy + 'static, u32: AsPrimitive<T>,

pub fn new(rate: u32) -> Self

Create a new zero-initialized filter with the given rate change.

pub const fn order(&self) -> usize

Filter order

• 0: zero order hold
• 1: linear
• 2: quadratic
• 3: cubic interpolation/decimation

etc.

pub const fn rate(&self) -> u32

Rate change

fast/slow - 1

pub fn set_rate(&mut self, rate: u32)

Set the rate change

fast/slow - 1

pub fn clear(&mut self)

Zero-initialize the filter state

pub const fn tick(&self) -> bool

Accepts/provides new slow-rate sample

Interpolator: accepts new input sample Decimator: returns new output sample

pub fn get_interpolate(&self) -> T

Current interpolator output

pub fn get_decimate(&self) -> T

Current decimator output

pub fn gain(&self) -> T

Filter gain

pub const fn gain_log2(&self) -> u32

Right shift amount

log2(gain()) if gain is a power of two, otherwise an upper bound.

pub const fn response_length(&self) -> usize

Impulse response length

pub fn settle_interpolate(&mut self, x: T)

Establish a settled filter state

pub fn settle_decimate(&mut self, x: T)

Establish a settled filter state

Unimplemented!

pub fn interpolate(&mut self, x: Option<T>) -> T

Optionally ingest a new low-rate sample and retrieve the next output.

A new sample must be supplied at the correct time (when Cic::tick() is true)

pub fn decimate(&mut self, x: T) -> Option<T>

Ingest a new high-rate sample and optionally retrieve next output.

Trait Implementations

impl<T: Clone, const N: usize> Clone for Cic<T, N>

fn clone(&self) -> Cic<T, N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, const N: usize> Debug for Cic<T, N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.