Struct Coverage 

pub struct Coverage {
    pub intended: u32,
    pub used: u32,
    pub missing: u32,
    pub ambiguous: u32,
}

How much of what an analysis meant to use it actually used.

“Intended” comes from what a component should contain, not from what the file happened to have — so a residue whose side chain was never modelled reduces coverage rather than silently shrinking the calculation.

Fields

intended: u32

Atoms the analysis meant to use.

used: u32

Atoms it did use.

missing: u32

Atoms absent from the model.

ambiguous: u32

Atoms present but not uniquely resolvable.

Implementations

impl Coverage

pub const fn complete(atoms: u32) -> Coverage

Coverage for an analysis that used everything it meant to.

pub fn fraction(self) -> f64

The fraction of intended atoms that were used.

An analysis over two fifths of the intended atoms is not the same quantity as one over all of them, and this is what says so.

Panics

The checked conversion accepts every unsigned 32-bit count.

pub const fn is_complete(self) -> bool

Returns true when nothing was missing or ambiguous.

Trait Implementations

impl Clone for Coverage

fn clone(&self) -> Coverage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Coverage

impl Debug for Coverage

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

Formats the value using the given formatter.

impl Default for Coverage

fn default() -> Coverage

Returns the “default value” for a type.

impl Eq for Coverage

impl PartialEq for Coverage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Coverage