Struct Violation 

pub struct Violation {
    pub quantity: String,
    pub site: String,
    pub before: f64,
    pub after: f64,
    pub scale: f64,
    pub tolerance: f64,
}

A conservation law that did not hold.

Fields

quantity: String

Which law: one of quantity, or a domain’s own name for it.

site: String

Where it broke — a domain name, a coupling name, a wavelength.

before: f64

What the quantity was, in SI base units.

after: f64

What it became.

scale: f64

What the discrepancy was measured against — the largest entry that went into the books, not the net total, since a correct system’s net is often zero. Zero means “use the totals”, which is what a non-conservation error does.

tolerance: f64

The tolerance that was being applied, so the report says how badly.

Implementations

impl Violation

pub fn at( site: impl Into<String>, quantity: impl Into<String>, detail: f64, ) -> Violation

For the cases that are not a before/after comparison at all: a surface specified to reflect more than it receives, an iteration that never converged.

pub fn error(&self) -> f64

Absolute size of the discrepancy.

pub fn relative_error(&self) -> f64

Discrepancy as a fraction of the scale it was judged against.

Trait Implementations

impl Clone for Violation

fn clone(&self) -> Violation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Violation

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

Formats the value using the given formatter.

impl Display for Violation

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

Formats the value using the given formatter.

impl Error for Violation

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for Violation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Violation