Struct NoSumSMA

pub struct NoSumSMA<T, D = T> { /* private fields */ }

Basic implementation of Simple Moving Average (SMA).

The maximum window size is bound by 2^32 - 1. Useful mainly for floating-point types, as it does not accumulate floating point error with each sample. Requires O(N) of memory and O(N) 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,…).

Implementations

impl<T, D> NoSumSMA<T, D>

where T: for<'a> Sum<&'a T> + Div<D, Output = T>, 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 NoSumSMA<T, D>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'de, T, D> Deserialize<'de> for NoSumSMA<T, D>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

where T: for<'a> Sum<&'a T> + Div<D, Output = T> + Default + Display, D: From<u32>,

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

Formats the value using the given formatter.

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

fn eq(&self, other: &NoSumSMA<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 NoSumSMA<T, D>

where T: for<'a> Sum<&'a T> + Div<D, Output = T>, 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 is_window_full(&self) -> bool

Indicates whether the window is fully occupied with samples.

impl<T, D> Serialize for NoSumSMA<T, D>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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