Struct Multiplicity

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

A scalar type common for node capacity, harc weight and state.

Valid multiplicities are nonnegative integers or ω.

Implementations

impl Multiplicity

pub const fn omega() -> Self

pub fn finite(value: u64) -> Option<Self>

pub const fn zero() -> Self

pub const fn one() -> Self

pub fn is_omega(self) -> bool

pub fn is_zero(self) -> bool

pub fn is_finite(self) -> bool

pub fn is_positive(self) -> bool

pub fn checked_add(self, other: Self) -> Option<Self>

pub fn checked_sub(self, other: Self) -> Option<Self>

pub fn saturating_add(self, other: Self) -> Self

Note: don’t use this for evaluation of state transition; call checked_add() instead.

pub fn saturating_sub(self, other: Self) -> Self

Note: don’t use this for evaluation of state transition; call checked_sub() instead.

Trait Implementations

impl Clone for Multiplicity

fn clone(&self) -> Multiplicity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Multiplicity

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

Formats the value using the given formatter.

impl Display for Multiplicity

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

Formats the value using the given formatter.

impl FromStr for Multiplicity

type Err = AcesError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Multiplicity

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 Multiplicity

fn cmp(&self, other: &Multiplicity) -> 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 Multiplicity

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

fn partial_cmp(&self, other: &Multiplicity) -> 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 Multiplicity

impl Eq for Multiplicity

impl StructuralPartialEq for Multiplicity