Struct ascesis::Multiplicity

#[repr(transparent)]
pub struct Multiplicity(_);

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

Valid multiplicities are nonnegative integers or ω.

Methods

impl Multiplicity

pub const fn omega() -> Multiplicity

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

pub const fn zero() -> Multiplicity

pub const fn one() -> Multiplicity

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: Multiplicity) -> Option<Multiplicity>

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

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

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

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

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 Copy for Multiplicity

impl Debug for Multiplicity

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

Formats the value using the given formatter.

impl Display for Multiplicity

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

Formats the value using the given formatter.

impl Eq for Multiplicity

impl Hash for Multiplicity

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

Feeds this value into the given [Hasher].

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

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<Multiplicity> for Multiplicity

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Multiplicity> 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: &Multiplicity) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for Multiplicity

impl StructuralPartialEq for Multiplicity