Struct DeltaFloat

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

Simple metric for absolute difference of 1-dimentional f32 or f64’s

Example:

let mut diff = metrics::DeltaFloat::new();
assert!(diff.observe(1.5_f32).is_nan());
assert_eq!(diff.observe(2.5_f32), 1.0);

Implementations

impl<T: Float> DeltaFloat<T>

pub fn new() -> Self

Trait Implementations

impl<T: Clone> Clone for DeltaFloat<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DeltaFloat<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for DeltaFloat<T>

fn default() -> DeltaFloat<T>

Returns the “default value” for a type.

impl<T> Display for DeltaFloat<T>

where DeltaFloat<T>: StatefulMetric<T, Output = f64>,

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

Formats the value using the given formatter.

impl<I: Float> Metric<I> for DeltaFloat<I>

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: I) -> 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<I: Float> StatefulMetric<I> for DeltaFloat<I>

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

The calculated value.

fn store(&mut self, x: I)

Stores the value, and likely discards older values.

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

fn value(&self) -> f64

where Self::Output: Into<f64>,

The calculated value.