Struct sp_arithmetic::Rational128

pub struct Rational128(_, _);

A wrapper for any rational number with a 128 bit numerator and denominator.

Implementations

impl Rational128

pub fn zero() -> Self

Nothing.

pub fn is_zero(&self) -> bool

If it is zero or not

pub fn from(n: u128, d: u128) -> Self

Build from a raw n/d.

pub fn from_unchecked(n: u128, d: u128) -> Self

Build from a raw n/d. This could lead to / 0 if not properly handled.

pub fn n(&self) -> u128

Return the numerator.

pub fn d(&self) -> u128

Return the denominator.

pub fn to_den(self, den: u128) -> Result<Self, &'static str>

Convert self to a similar rational number where denominator is the given den. This only returns if the result is accurate. Err is returned if the result cannot be accurately calculated.

pub fn lcm(&self, other: &Self) -> Result<u128, &'static str>

Get the least common divisor of self and other.

This only returns if the result is accurate. Err is returned if the result cannot be accurately calculated.

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

A saturating add that assumes self and other have the same denominator.

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

A saturating subtraction that assumes self and other have the same denominator.

pub fn checked_add(self, other: Self) -> Result<Self, &'static str>

Addition. Simply tries to unify the denominators and add the numerators.

Overflow might happen during any of the steps. Error is returned in such cases.

pub fn checked_sub(self, other: Self) -> Result<Self, &'static str>

Subtraction. Simply tries to unify the denominators and subtract the numerators.

Overflow might happen during any of the steps. None is returned in such cases.

Trait Implementations

impl Clone for Rational128

pub fn clone(&self) -> Rational128

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Rational128

impl Debug for Rational128

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

Formats the value using the given formatter.

impl Default for Rational128

pub fn default() -> Rational128

Returns the "default value" for a type.

impl Eq for Rational128

impl Ord for Rational128

pub fn cmp(&self, other: &Self) -> 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 PartialEq<Rational128> for Rational128

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

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

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

This method tests for !=.

impl PartialOrd<Rational128> for Rational128

pub fn partial_cmp(&self, other: &Self) -> 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 StructuralEq for Rational128