Struct Metrics 

pub struct Metrics { /* private fields */ }

The metrics of a link (see the module documentation).

Implementations

impl Metrics

pub fn from_json(v: &Json) -> Result<Metrics>

Parse the metrics mapping of a specification (null gives the defaults).

Errors

Error::Config for an unknown metric, key or scaling.

pub fn names(&self) -> Vec<&'static str>

The reported metrics.

pub fn record_frame(&self, s: &Frame, rec: &mut Record) -> Result<()>

Record what a trial of a link records after its blocks (crate::Link::trial): the metrics of the frame (Metrics::record), then the values and the probes that its blocks recorded. The Python chains record their frames with it.

Errors

As Metrics::record.

pub fn record(&self, s: &Frame, rec: &mut Record) -> Result<()>

Evaluate the metrics of one trial and record them.

Errors

Error::Config for a coded metric without a coded link, or a signal that is not at one sample per symbol aligned on the symbols; Error::Shape if the window is empty.

Trait Implementations

impl Clone for Metrics

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metrics

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

Formats the value using the given formatter.