Struct rational_deduction::RatioPair

pub struct RatioPair<V> {
    pub top: V,
    pub bot: V,
}

Canonical Ratio Type

Fields

top: V

Top of the ratio

bot: V

Bottom of the ratio

Trait Implementations

impl<V: Clone> Clone for RatioPair<V>

fn clone(&self) -> RatioPair<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Copy> Copy for RatioPair<V>

impl<V: Debug> Debug for RatioPair<V>

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

Formats the value using the given formatter.

impl<V: Default> Default for RatioPair<V>

fn default() -> RatioPair<V>

Returns the “default value” for a type.

impl<V: Eq> Eq for RatioPair<V>

impl<V> From<(V, V)> for RatioPair<V>

fn from(pair: (V, V)) -> Self

Performs the conversion.

impl<V: Hash> Hash for RatioPair<V>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<V: Ord> Ord for RatioPair<V>

fn cmp(&self, other: &RatioPair<V>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<V: PartialEq> PartialEq<RatioPair<V>> for RatioPair<V>

fn eq(&self, other: &RatioPair<V>) -> bool

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

fn ne(&self, other: &RatioPair<V>) -> bool

This method tests for !=.

impl<V: PartialOrd> PartialOrd<RatioPair<V>> for RatioPair<V>

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<V> Ratio<V> for RatioPair<V>

fn new(top: V, bot: V) -> Self

Create a new ratio from two base type elements.

fn cases(&self) -> RatioPairRef<'_, V>

Get reference to top and bottom of ratio.

fn top(self) -> V

Get the top element.

fn top_ref(&self) -> &V

Get reference to the top element.

fn bot(self) -> V

Get the bottom element.

fn bot_ref(&self) -> &V

Get reference to the bottom element.

fn from_pair(pair: RatioPair<V>) -> Self

Convert from a RatioPair.

fn reverse(self) -> Self

Reverse a Ratio.

fn default() -> Self where
    V: Default, 

Get the default ratio.

fn clone(&self) -> Self where
    V: Clone, 

Clone a Ratio.

fn eq<RV, R>(&self, other: &R) -> bool where
    R: Ratio<RV>,
    V: PartialEq<RV>, 

Check if two Ratios are equal.

fn eq_by<RV, R, F>(&self, other: &R, eq: F) -> bool where
    R: Ratio<RV>,
    F: FnMut(&V, &RV) -> bool, 

Check if two Ratios are equal given the comparison function.

fn eq_by_symmetric_cancellation<RV, R, F>(&self, other: &R, eq: F) -> bool where
    R: Ratio<RV>,
    F: FnMut(&V, &RV) -> bool, 

Check if two Ratios are equal by checking if they cancel symmetrically.

fn pair_compose<T>(top: Self, bot: Self) -> Self where
    V: IntoIterator + FromIterator<<V as IntoIterator>::Item>,
    V::Item: PartialEq, 

Compose two ratios using the ratio monoid multiplication algorithm.

fn pair_compose_by<F>(top: Self, bot: Self, eq: F) -> Self where
    V: IntoIterator + FromIterator<<V as IntoIterator>::Item>,
    F: FnMut(&V::Item, &V::Item) -> bool, 

Compose two ratios using the ratio monoid multiplication algorithm.

fn compose<I>(ratios: I) -> Self where
    V: IntoIterator + FromIterator<<V as IntoIterator>::Item>,
    V::Item: PartialEq,
    I: IntoIterator<Item = Self>, 

Fold a collection of ratios using pair_compose.

fn compose_by<I, F>(ratios: I, eq: F) -> Self where
    V: IntoIterator + FromIterator<<V as IntoIterator>::Item>,
    I: IntoIterator<Item = Self>,
    F: FnMut(&V::Item, &V::Item) -> bool, 

Fold a collection of ratios using pair_compose_by.

fn has_cancellation(top: &Self, bot: &Self) -> bool where
    V: IntoIterator + FromIterator<<V as IntoIterator>::Item>,
    V::Item: PartialEq, 

Check if there would be any cancellation if you composed the two elements.

fn has_cancellation_by<F>(top: &Self, bot: &Self, eq: F) -> bool where
    V: IntoIterator + FromIterator<<V as IntoIterator>::Item>,
    F: FnMut(&V::Item, &V::Item) -> bool, 

Check if there would be any cancellation if you composed the two elements.

impl<V> StructuralEq for RatioPair<V>

impl<V> StructuralPartialEq for RatioPair<V>

impl<E> TryFrom<Expr<E>> for RatioPair<E::Group> where
    E: Expression,
    E::Group: IntoIterator<Item = E>, 

type Error = RatioPairFromExprError

The type returned in the event of a conversion error.

fn try_from(expr: Expr<E>) -> Result<Self, Self::Error>

Parse an Expr<E> into a RatioPair<E> if it has the correct shape.