Struct SmoothBuffer

pub struct SmoothBuffer<const CAP: usize, T: Num> { /* private fields */ }

Simple fixed size ringbuffer with fast averaging.

Implementations

impl<const CAP: usize, T: Num> SmoothBuffer<CAP, T>

pub fn new() -> Self

Creates a new, empty buffer.

pub fn pre_filled(value: T) -> Self

Creates a new buffer pre-populated with a value, filled to capacity.

pub fn average(&self) -> T

Fast! Sum is always kept up to date on push. No need to iterate.

pub fn clear(&mut self)

Resets buffer to its default empty state.

pub fn is_empty(&self) -> bool

True is buffer is empty.

pub fn max(&self) -> T

The largest value so far, if any.

pub fn min(&self) -> T

The smallest value so far, if any.

pub fn capacity(&self) -> usize

The maximum number of items. Older items are discarded in favor of newer ones if capacity is exceeded.

pub fn len(&self) -> usize

Current value count, will always be lower or equal to capacity.

pub fn push(&mut self, value: T)

Push a single value.

pub fn push_slice(&mut self, slice: &[T])

Pushes multiple values at once.

pub fn iter(&self) -> Iter<'_, T>

Iterates through all values. Order of retrieval will likely NOT match order of input.

impl<const CAP: usize, T: Float> SmoothBuffer<CAP, T>

pub fn gaussian_filter(&self) -> T

Gaussian smoothing. Much slower than a simple average, will actually iterate through all values and return a weighted sum.

Trait Implementations

impl<const CAP: usize, T: Num> Default for SmoothBuffer<CAP, T>

fn default() -> Self

Returns the “default value” for a type.