Struct MovingSpread

pub struct MovingSpread { /* private fields */ }

Calculates the spread, the (max-min) in a moving window.

Example:

let mut spread = metrics::MovingSpread::new(3);
assert_eq!(spread.observe(1.4).is_nan(), true);
assert_eq!(spread.observe(1.2).is_nan(), true);
assert_approx_eq!(spread.observe(1.3), 0.2);
assert_approx_eq!(spread.observe(-0.5), 1.8);

Implementations

impl MovingSpread

pub fn new(window_size: usize) -> Self

Trait Implementations

impl Clone for MovingSpread

fn clone(&self) -> MovingSpread

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MovingSpread

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

Formats the value using the given formatter.

impl Display for MovingSpread

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

Formats the value using the given formatter.

impl Metric<f64> for MovingSpread

type Output = f64

The type of elements recorded by the metric. For a delta of last vs current, this might be an n-dimentional vector. It typically needs to be an Owned type, rather than a reference.

fn observe_opt(&mut self, x: f64) -> Option<Self::Output>

Similar to observe except None is returned instead of f64::NAN to indicate not enough data collected. Useful if you like

fn observe(&mut self, x: Input) -> f64

where Self::Output: Into<f64>,

Records the value, and return the calculated metric. If there are not enough samples to calculate the metric, f64::NAN is returned, which will always compare false. So a tolerance check observe(x) < 0.0001 will fail until enough samples have been collected. If you don’t like NANs, then Metric::observe_opt is your friend.

impl StatefulMetric<f64> for MovingSpread

fn store(&mut self, x: f64)

Stores the value, and likely discards older values.

fn value_opt(&self) -> Option<f64>

The calculated value.

fn observe_opt(&mut self, x: Input) -> Option<Self::Output>

fn value(&self) -> f64

where Self::Output: Into<f64>,

The calculated value.