Struct SingleSumSMA 

pub struct SingleSumSMA<T, D = T> {
    window: VecDeque<T>,
    window_size: usize,
    sum: T,
    _div: PhantomData<D>,
}

Basic implementation of Simple Moving Average (SMA).

The maximum window size is bound by 2^32 - 1. Useful mainly for integer types, as it does accumulate floating point error with each sample. Requires O(N) of memory and O(1) for average computation, N being window size. The divisor argument D is used only for such types T that do not implement From<u32> (such as Duration,…).

Fields

window: VecDeque<T>

window_size: usize

sum: T

_div: PhantomData<D>

Implementations

impl<T, D> SingleSumSMA<T, D>

where T: AddAssign + SubAssign + Div<D, Output = T> + Copy + Default, D: From<u32>,

pub fn new(window_size: usize) -> Self

Creates an empty SMA instance with the given window size. The maximum window size is u32::MAX and must be greater than 1.

pub fn new_with_samples<I>(window_size: usize, initial_samples: I) -> Self

where I: IntoIterator<Item = T>,

Creates SMA instance given window size and some initial samples.

Trait Implementations

impl<T: Clone, D: Clone> Clone for SingleSumSMA<T, D>

fn clone(&self) -> SingleSumSMA<T, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, D: Debug> Debug for SingleSumSMA<T, D>

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

Formats the value using the given formatter.

impl<T, D> Display for SingleSumSMA<T, D>

where T: AddAssign + SubAssign + Div<D, Output = T> + Copy + Display + Default, D: From<u32>,

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

Formats the value using the given formatter.

impl<T: PartialEq, D: PartialEq> PartialEq for SingleSumSMA<T, D>

fn eq(&self, other: &SingleSumSMA<T, D>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, D> SMA<T> for SingleSumSMA<T, D>

where T: AddAssign + SubAssign + Div<D, Output = T> + Copy, D: From<u32>,

fn push(&mut self, sample: T)

Pushes a sample.

fn average(&self) -> Option<T>

Calculates the moving average value. Returns None if no samples were added.

fn window_size(&self) -> usize

Returns the window size.

fn len(&self) -> usize

Returns the number of elements in the window. This value is always between 0 and window_size().

fn is_empty(&self) -> bool

Indicates whether there are no samples.

fn clear(&mut self)

Clears all the samples.

fn is_window_full(&self) -> bool

Indicates whether the window is fully occupied with samples.

impl<T, D> StructuralPartialEq for SingleSumSMA<T, D>