Skip to main content

RingSource

Struct RingSource 

Source
pub struct RingSource<const N: usize> { /* private fields */ }
Expand description

A fixed-capacity ring buffer residual source for embedded/bare-metal.

Accepts streamed residual norms one at a time and exposes the most recent N observations as a contiguous slice. All storage is stack-allocated.

Implementations§

Source§

impl<const N: usize> RingSource<N>

Source

pub const fn new(snr_db: f32) -> Self

Create a new ring source.

Source

pub fn push(&mut self, norm: f32)

Push a new residual norm into the ring buffer.

Source

pub fn set_snr_db(&mut self, snr_db: f32)

Update the SNR estimate.

Trait Implementations§

Source§

impl<const N: usize> ResidualSource for RingSource<N>

Source§

fn residual_norms(&self) -> &[f32]

Borrow the current residual norm buffer as an immutable slice. Read more
Source§

fn snr_estimate_db(&self) -> f32

Current SNR estimate in dB. Return f32::NAN if unknown.
Source§

fn sample_count(&self) -> usize

Number of valid samples in the current buffer.

Auto Trait Implementations§

§

impl<const N: usize> Freeze for RingSource<N>

§

impl<const N: usize> RefUnwindSafe for RingSource<N>

§

impl<const N: usize> Send for RingSource<N>

§

impl<const N: usize> Sync for RingSource<N>

§

impl<const N: usize> Unpin for RingSource<N>

§

impl<const N: usize> UnsafeUnpin for RingSource<N>

§

impl<const N: usize> UnwindSafe for RingSource<N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.