Struct comlib_math::Quot

pub struct Quot<T: Integer> { /* fields omitted */ }

A quotient. Represents a rational number as numerator/denominator.

The denominator is stored as non-zeroable type, so this type benefits from the niche optimization.

Implementations

impl<T: Integer> Quot<T>

pub fn new(numerator: T, denominator: T) -> Option<Self>

Constructs a new Quot from a numerator and a denominator.

Return None if the denominator is 0.

pub fn new_nonzero(numerator: T, denominator: T::NonZero) -> Self

Constructs a new Quot from a numerator and a non-zero denominator.

pub fn zero() -> Self

Gets the 0-value.

pub fn numerator(self) -> T

Gets the numerator of the quotient.

pub fn denominator(self) -> T

Gets the denominator of the quotient.

pub fn trunc(self) -> T

Truncates the quotient.

This gives out the integral part of the quotient.

pub fn abs(self) -> Self where
    T: Signed, 

Computes the absolute value of the quotient.

Trait Implementations

impl<T: Integer, R> Add<R> for Quot<T> where
    R: Into<Self>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<T: Integer, R> AddAssign<R> for Quot<T> where
    R: Into<Self>, 

fn add_assign(&mut self, rhs: R)

Performs the += operation.

impl<T: Clone + Integer> Clone for Quot<T> where
    T::NonZero: Clone, 

fn clone(&self) -> Quot<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Integer> Debug for Quot<T>

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

Formats the value using the given formatter.

impl<T: Integer> Default for Quot<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Integer> Display for Quot<T>

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

Formats the value using the given formatter.

impl<T: Integer, R> Div<R> for Quot<T> where
    R: Into<Self>, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl<T: Integer, R> DivAssign<R> for Quot<T> where
    R: Into<Self>, 

fn div_assign(&mut self, rhs: R)

Performs the /= operation.

impl<T: Integer> From<&'_ T> for Quot<T>

fn from(v: &T) -> Self

Performs the conversion.

impl<T: Integer> From<T> for Quot<T>

fn from(v: T) -> Self

Performs the conversion.

impl<T: Integer, R> Mul<R> for Quot<T> where
    R: Into<Self>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Self::Output

Performs the * operation.

impl<T: Integer, R> MulAssign<R> for Quot<T> where
    R: Into<Self>, 

fn mul_assign(&mut self, rhs: R)

Performs the *= operation.

impl<T: Integer + Signed> Neg for Quot<T>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Integer> Numeric for Quot<T>

fn zero() -> Self

Returns zero.

fn one() -> Self

Returns one.

fn from_int(value: i8) -> Self

Converts the given integer to the type.

fn as_f32(self) -> f32

Converts the number to f32.

fn as_f64(self) -> f64

Converts the number to f64.

fn is_zero(self) -> bool

Tests whether value is zero.

fn is_one(self) -> bool

Tests whether value is one.

impl<T: Integer> Ord for Quot<T>

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

Restrict a value to a certain interval.

impl<T: Integer> PartialEq<Quot<T>> for Quot<T>

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

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

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

This method tests for !=.

impl<T: Integer> PartialOrd<Quot<T>> for Quot<T>

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

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

fn lt(&self, other: &Rhs) -> bool

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

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

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

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

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

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<T: Integer, R> Rem<R> for Quot<T> where
    R: Into<Self>, 

type Output = Self

The resulting type after applying the % operator.

fn rem(self, rhs: R) -> Self::Output

Performs the % operation.

impl<T: Integer, R> RemAssign<R> for Quot<T> where
    R: Into<Self>, 

fn rem_assign(&mut self, rhs: R)

Performs the %= operation.

impl<T: Integer + Signed> Signed for Quot<T>

fn get_sign(self) -> Sign

Returns the sign of the number.

fn get_abs(self) -> Self

Returns the absolute value of the number.

impl<T: Integer, R> Sub<R> for Quot<T> where
    R: Into<Self>, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<T: Integer, R> SubAssign<R> for Quot<T> where
    R: Into<Self>, 

fn sub_assign(&mut self, rhs: R)

Performs the -= operation.

impl<T: Copy + Integer> Copy for Quot<T> where
    T::NonZero: Copy, 

impl<T: Integer> Eq for Quot<T> where
    Self: PartialEq,