Struct MetricMap

pub struct MetricMap(/* private fields */);

Implementations

impl MetricMap

pub fn new() -> MetricMap

pub fn insert_metric(&mut self, name: &str, value: f64, noise: f64)

Insert a named value (+/- noise) metric into the map. The value must be non-negative. The noise indicates the uncertainty of the metric, which doubles as the “noise range” of acceptable pairwise-regressions on this named value, when comparing from one metric to the next using compare_to_old.

If noise is positive, then it means this metric is of a value you want to see grow smaller, so a change larger than noise in the positive direction represents a regression.

If noise is negative, then it means this metric is of a value you want to see grow larger, so a change larger than noise in the negative direction represents a regression.

pub fn fmt_metrics(&self) -> String

Trait Implementations

impl Clone for MetricMap

fn clone(&self) -> MetricMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for MetricMap

fn eq(&self, other: &MetricMap) -> 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 StructuralPartialEq for MetricMap