Struct e_ring::Ring

pub struct Ring<T, const N: usize> { /* fields omitted */ }

Append only data structure, replace oldest element when reach maximum capacity of N elements

Implementations

impl<T: Copy + Default + PartialOrd + Sub<Output = T> + Add<Output = T> + Mul<Output = T> + Div<Output = T> + Into<f32>, const N: usize> Ring<T, N>

pub fn avg(&self) -> f32

Calculate the average of the elements in the Ring

pub fn var(&self, avg: Option<f32>) -> f32

Calculate the variance of the elements in the Ring, use provided avg if Some, otherwise it calculates it (in the latter case two iterations are required).

impl<T: Copy + Default + PartialOrd + Sub<Output = T> + Add<Output = T> + Mul<Output = T> + Div<Output = T> + Into<f64>, const N: usize> Ring<T, N>

pub fn rescaled_iter(
    &self,
    current: Range<T>,
    desired: Range<T>
) -> RescaleIterator<'_, T, N>

Returns an iterator over the Ring on which values are rescaled according to the desired range

impl<T: Copy + Default, const N: usize> Ring<T, N>

pub fn new() -> Self

Creates a new Ring of give size N

pub fn append(&mut self, el: T)

Append an element to the Ring, if there are already N elements, it replaces the oldest.

pub fn len(&self) -> usize

Number of elements in the Ring, it never decreases.

pub fn is_empty(&self) -> bool

If the Ring is empty. Zero elements

pub fn size(&self) -> usize

Return the max size of the ring

pub fn last(&self) -> Option<T>

Return the last item inserted

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

Returns an iterator over the Ring starting from the oldest appended element

Trait Implementations

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

fn clone(&self) -> Ring<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 Ring<T, N>

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

Formats the value using the given formatter.

impl<T: Copy + Default, const N: usize> Default for Ring<T, N>

fn default() -> Self

Returns the “default value” for a type.

impl<T: PartialOrd + Copy + Default, const N: usize> FindRange<T> for Ring<T, N>

fn range(&self) -> Option<Range<T>>

calculate min and max with one iteration