Struct Record 

pub struct Record { /* private fields */ }

The metrics reported by one trial, or merged over many.

Implementations

impl Record

pub fn new() -> Record

An empty record.

pub fn for_trial(trial: u64) -> Record

An empty record of trial trial of its condition (the runner numbers the trials; blocks that save or label a trial read it).

pub fn trial(&self) -> u64

The index of the trial of the condition this record belongs to (0 when merged).

pub fn errors(&mut self, name: &str, errors: u64, total: u64)

Add errors errors among total events to the error rate name.

If name is already a mean, the addition is dropped and counted (Record::dropped).

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

Add a value to the mean name.

A non-finite value, or a value for a metric that is already an error rate, is dropped and counted (Record::dropped).

pub fn values(&mut self, name: &str, vs: impl IntoIterator<Item = f64>)

Add several values to the mean name (see Record::value).

pub fn merge(&mut self, o: &Record)

Merge another record: metrics of the same name and kind are combined, the drop counts are added. A metric of the other kind is dropped and counted: as many values as it holds for a mean, one for a rate.

pub fn dropped(&self, name: &str) -> u64

The number of values of name dropped: non-finite, or of the other kind of metric (0 if none).

Examples

use comnum_sim::scenario::Record;
let mut rec = Record::new();
rec.value("snr_db", 12.0);
rec.value("snr_db", f64::INFINITY);    // an error-free trial
rec.errors("snr_db", 1, 10);           // the wrong kind
assert_eq!(rec.get("snr_db").unwrap().count(), 1);
assert_eq!(rec.dropped("snr_db"), 2);

pub fn dropped_iter(&self) -> impl Iterator<Item = (&String, u64)>

The metrics with dropped values and their counts, sorted by name.

pub fn knows(&self, name: &str) -> bool

Whether name was recorded, as an estimate or only as dropped values.

pub fn get(&self, name: &str) -> Option<&Estimate>

The estimate of name.

pub fn iter(&self) -> impl Iterator<Item = (&String, &Estimate)>

The metrics, sorted by name.

pub fn is_empty(&self) -> bool

Whether the record holds no metric.

Trait Implementations

impl Clone for Record

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 Record

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

Formats the value using the given formatter.

impl Default for Record

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Record

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Record