Struct RollingMedian

pub struct RollingMedian<T> { /* private fields */ }

A rolling median type.

This keeps track of a window of items and allows calculating the RollingMedian::median of them.

Example:

let mut rolling_median = RollingMedian::new(2);

rolling_median.push(1);
assert_eq!(rolling_median.median(), 1);
assert_eq!(rolling_median.window_len(), 1);

rolling_median.push(3);
assert_eq!(rolling_median.median(), 2);
assert_eq!(rolling_median.window_len(), 2);

rolling_median.push(5);
assert_eq!(rolling_median.median(), 4);
assert_eq!(rolling_median.window_len(), 2);

Implementations

impl<T> RollingMedian<T>

where T: Ord + PartialOrd + Add<Output = T> + Sub<Output = T> + Div<Output = T> + Mul<Output = T> + Copy + From<u8>,

pub fn new(target_window: usize) -> Self

Creates a new RollingMedian with a certain target window length.

target_window is the maximum amount of items to keep in the rolling window.

pub fn from_vec(vec: Vec<T>, target_window: usize) -> Self

Creates a new RollingMedian from a Vec with a certain target window length.

target_window is the maximum amount of items to keep in the rolling window.

Panics

This function panics if vec.len() > target_window.

pub fn pop_front(&mut self)

Pops the front of the window, i.e. the oldest item.

This is often not needed as RollingMedian::push will handle popping old values when they fall out of the window.

pub fn pop_back(&mut self)

Pops the back of the window, i.e. the youngest item.

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

Push an item to the back of the window.

This will pop the oldest item in the window if the target length has been exceeded.

pub fn append_front(&mut self, items: Vec<T>)

Append some values to the front of the window.

These new values will be the oldest items in the window. The order of the inputted items will be kept, i.e. the first item in the Vec will be the oldest item in the queue.

pub fn window_len(&self) -> usize

Returns the number of items currently in the RollingMedian.

pub fn median(&self) -> T

Calculates the median of the values currently in the RollingMedian.

Trait Implementations

impl<T: Clone> Clone for RollingMedian<T>

fn clone(&self) -> RollingMedian<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for RollingMedian<T>

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

Formats the value using the given formatter.

impl<T: Ord> Ord for RollingMedian<T>

fn cmp(&self, other: &RollingMedian<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for RollingMedian<T>

fn eq(&self, other: &RollingMedian<T>) -> 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: PartialOrd> PartialOrd for RollingMedian<T>

fn partial_cmp(&self, other: &RollingMedian<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for RollingMedian<T>

impl<T> StructuralPartialEq for RollingMedian<T>

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 64 bytes