Struct Metric 

pub struct Metric {
    pub relative: Option<f64>,
    pub absolute: Option<f64>,
    pub not_scored: Option<String>,
}

One metric of a case: how far hpr may be from the reference, or why it is not scored.

In a case file that is a table of one or both bounds:

[metrics.descent_time_s]
relative = 0.03

[metrics.drift_north_m]
relative = 0.03
absolute = 0.002    # this component passes through zero, so a fraction alone means nothing

A metric whose table sets neither is refused, because that is the “ungated metric” of Loft lesson L79 by another name.

The one alternative to a gate is to say, in the case file, that the metric is not scored and why:

[metrics.drift_north_m]
not_scored = "hpr and RocketPy differ by 28x on 0.5 mm and the cause is not established (#27)"

Such a metric is still measured and still printed, with both numbers, the difference and the reason: it is a gap on the face of the report, not a quiet omission and not a pass. Loft excused its two largest misses as “no single target” (Loft lesson L82), so the reason has to be written down, and hpr_validate::tests::the_metrics_that_are_not_scored_are_these_and_no_others pins the whole set: a new excuse has to be argued in a test whose name says what it is.

Fields

relative: Option<f64>

How far hpr may be from the reference, as a fraction of it (0.03 for 3%).

absolute: Option<f64>

How far hpr may be from the reference, in the metric’s own unit.

not_scored: Option<String>

Why the metric is measured and reported but not scored. Mutually exclusive with a bound.

Implementations

impl Metric

pub fn relative(relative: f64) -> Self

A relative bound alone.

pub fn tolerance(&self) -> Tolerance

The bounds it holds hpr to.

pub fn reason(&self) -> Option<&str>

The reason it is not scored, if it says one.

pub fn check(&self, case: &str, name: &str) -> Result<(), String>

Checks that the metric is either gated or declared, and that its bounds are real numbers that bound something.

Errors

A sentence naming what is wrong, for crate::run::ValidateError::Case.

Trait Implementations

impl Clone for Metric

fn clone(&self) -> Metric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metric

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

Formats the value using the given formatter.

impl Default for Metric

fn default() -> Metric

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Metric

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Metric

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Metric