Struct BoundedCardinality

pub struct BoundedCardinality { /* private fields */ }

Contains a lower and upper bound Cardinality used to bound the cardinality of a Set.

Implementations

impl BoundedCardinality

pub fn new(lower: Cardinality, upper: Cardinality) -> Option<Self>

Creates an instance of BoundedCardinality.

Returns None iff lower > upper.

pub fn new_exact(exact: Cardinality) -> Self

Creates an instance of BoundedCardinality with the lower and upper bounds both set to exact.

pub fn from_biguint(lower: BigUint, upper: BigUint) -> Option<Self>

Creates an instance of BoundedCardinality with the lower and upper bounds as Cardinality::Finite of their respective values.

Returns None iff lower > upper.

pub fn from_biguint_exact(exact: BigUint) -> Self

Creates an instance of BoundedCardinality with the lower and upper bounds as Cardinality::Finite(exact).

pub const unsafe fn new_unsafe(lower: Cardinality, upper: Cardinality) -> Self

Creates an instance of BoundedCardinality without verifying lower <= upper.

Safety

lower <= upper.

pub const unsafe fn from_biguint_unsafe(lower: BigUint, upper: BigUint) -> Self

Creates an instance of BoundedCardinality with the lower and upper bounds as Cardinality::Finite of their respective values without verifying lower <= upper.

Safety

lower <= upper.

pub const fn lower(&self) -> &Cardinality

Returns a reference to the lower bound.

pub fn to_lower(self) -> Cardinality

Returns the lower bound.

pub const fn upper(&self) -> &Cardinality

Returns a reference to the upper bound.

pub fn to_upper(self) -> Cardinality

Returns the upper bound.

pub const fn lower_upper(&self) -> (&Cardinality, &Cardinality)

Returns a tuple containing the references to the lower and upper bounds respectively.

pub const fn lower_biguint(&self) -> &BigUint

Returns a reference to the contained BigUint of self.lower().

pub fn to_lower_biguint(self) -> BigUint

Returns the lower bound as a BigUint.

pub const fn upper_biguint(&self) -> &BigUint

Returns a reference to the contained BigUint of self.upper().

pub fn to_upper_biguint(self) -> BigUint

Returns the upper bound as a BigUint.

pub const fn lower_upper_biguint(&self) -> (&BigUint, &BigUint)

Returns a tuple of references to the contained BigUints of self.lower() and self.upper() respectively.

Trait Implementations

impl Clone for BoundedCardinality

fn clone(&self) -> BoundedCardinality

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoundedCardinality

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

Formats the value using the given formatter.

impl Display for BoundedCardinality

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

Formats the value using the given formatter.

impl From<BigUint> for BoundedCardinality

fn from(value: BigUint) -> Self

Converts to this type from the input type.

impl From<BoundedCardinality> for (BigUint, BigUint)

fn from(value: BoundedCardinality) -> Self

Converts to this type from the input type.

impl From<BoundedCardinality> for (Cardinality, Cardinality)

fn from(value: BoundedCardinality) -> Self

Converts to this type from the input type.

impl From<Cardinality> for BoundedCardinality

fn from(value: Cardinality) -> Self

Converts to this type from the input type.

impl Hash for BoundedCardinality

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 BoundedCardinality

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

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

fn partial_cmp(&self, other: &BoundedCardinality) -> 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 TryFrom<(BigUint, BigUint)> for BoundedCardinality

type Error = BoundedErr

The type returned in the event of a conversion error.

fn try_from(value: (BigUint, BigUint)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<(Cardinality, Cardinality)> for BoundedCardinality

type Error = BoundedErr

The type returned in the event of a conversion error.

fn try_from(value: (Cardinality, Cardinality)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<BoundedCardinality> for Cardinality

type Error = CardinalityErr

The type returned in the event of a conversion error.

fn try_from(value: BoundedCardinality) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for BoundedCardinality

impl StructuralPartialEq for BoundedCardinality