Struct MoleRatio 

pub struct MoleRatio(/* private fields */);

A mole ratio between two stoichiometric coefficients.

Implementations

impl MoleRatio

pub fn new( numerator: StoichiometricCoefficient, denominator: StoichiometricCoefficient, ) -> Result<Self, StoichiometryValidationError>

Creates a mole ratio from validated coefficients.

Errors

Returns StoichiometryValidationError::ZeroRatioDenominator if the denominator is structurally invalid.

pub fn from_values( numerator: u32, denominator: u32, ) -> Result<Self, StoichiometryValidationError>

Creates a mole ratio from raw coefficient values.

Errors

Returns StoichiometryValidationError::ZeroRatioDenominator when denominator is zero, or StoichiometryValidationError::ZeroCoefficient when numerator is zero.

pub const fn as_ratio(self) -> StoichiometricRatio

Returns the wrapped stoichiometric ratio.

pub const fn numerator(self) -> StoichiometricCoefficient

Returns the numerator coefficient.

pub const fn denominator(self) -> StoichiometricCoefficient

Returns the denominator coefficient.

Trait Implementations

impl Clone for MoleRatio

fn clone(&self) -> MoleRatio

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MoleRatio

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

Formats the value using the given formatter.

impl Display for MoleRatio

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

Formats the value using the given formatter.

impl Hash for MoleRatio

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MoleRatio

fn cmp(&self, other: &MoleRatio) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MoleRatio

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

fn partial_cmp(&self, other: &MoleRatio) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for MoleRatio

impl Eq for MoleRatio

impl StructuralPartialEq for MoleRatio