Struct sss_rs::geometry::fraction::Fraction

pub struct Fraction { /* fields omitted */ }

A signed numerical value that is used to represent a fractional value or a whole value without having to worry about decimals and truncating. While both the @numerator and @denominator are signed values, only the numerator is allowed to be negative. The denominator is signed to make mathematical operations easier and will sometimes need to be negative during an operation but the sign will be moved to the numerator automatically

Methods

impl Fraction

pub fn new(numerator: i64, denominator: i64) -> Self

Creates a new fraction with the given numerator and denominator, which accepts any value that implements Into. @numerator: The numerator of the fraction @denominator: The denominator of the fraction

pub fn get_numerator(&self) -> i64

Returns a reference to the numerator of the fraction

pub fn get_denominator(&self) -> i64

Returns a reference to the denominator of the fraction

pub fn negate(self) -> Self

Consumes the fraction and returns the negation of it

pub fn add_fraction(self, other: Fraction) -> Self

Consuming add operation

pub fn sub_fraction(self, other: Fraction) -> Self

Consuming sub operation

pub fn mul_fraction(self, other: Fraction) -> Self

Consuming multiplication operation

pub fn div_fraction(self, other: Fraction) -> Self

Consuming division operation

pub fn mod_fraction(self, rhs: Fraction) -> Self

Consuming modulo operation

pub fn add_i64(self, rhs: i64) -> Self

Consuming add operation with the right hand side being a i64

pub fn sub_i64(self, rhs: i64) -> Self

Consuming sub operation with the right hand side being a i64

pub fn mul_i64(self, rhs: i64) -> Self

Consuming multiplication operation with the right hand side being a i64

pub fn div_i64(self, rhs: i64) -> Self

Consuming division operation with the right hand side being a i64

pub fn mod_i64(self, rhs: i64) -> Self

Consuming modulo operation with the right hand side being a i64

pub fn floor(self) -> Self

Consuming floor operation that "truncates" the fraction to a whole number

pub fn ceiling(self) -> Self

pub fn abs(self) -> Self

Consuming absolute value operation, if the fraction is negative, it is made positive

pub fn match_denominator(&mut self, other: &mut Fraction)

Matches the denominator of @self and another given fraction, which is used to make addtion and subtraction operations possible.

pub fn flip(self) -> Self

Consuming operation that flips the fraction

pub fn is_whole(&self) -> bool

Checks if the given fraction is a whole number, returns true if it is, false otherwise

Trait Implementations

impl NaturalMod<i64> for Fraction

type Output_ = Fraction

fn natural_mod(self, rhs: i64) -> Fraction

Computes the natural modulo of two given numbers.

impl AsRef<Fraction> for Term

fn as_ref(&self) -> &Fraction

Performs the conversion.

impl<T: Into<i64> + Debug> From<T> for Fraction

fn from(num: T) -> Self

Performs the conversion.

impl Clone for Fraction

fn clone(&self) -> Fraction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Fraction

impl Default for Fraction

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Fraction

impl Ord for Fraction

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

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

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

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

This method tests for !=.

impl PartialOrd<Fraction> for Fraction

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

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

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

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

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

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

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

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

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

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

impl Display for Fraction

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

Formats the value using the given formatter.

impl Debug for Fraction

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

Formats the value using the given formatter.

impl Div<Fraction> for Fraction

type Output = Fraction

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'_> Div<&'_ Fraction> for Fraction

type Output = Fraction

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'_> Div<Fraction> for &'_ Fraction

type Output = Fraction

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'_, '_> Div<&'_ Fraction> for &'_ Fraction

type Output = Fraction

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i64> for Fraction

type Output = Fraction

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'_> Div<&'_ i64> for Fraction

type Output = Fraction

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'_> Div<i64> for &'_ Fraction

type Output = Fraction

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'_, '_> Div<&'_ i64> for &'_ Fraction

type Output = Fraction

The resulting type after applying the / operator.

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

Performs the / operation.

impl Rem<Fraction> for Fraction

type Output = Fraction

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'_> Rem<&'_ Fraction> for Fraction

type Output = Fraction

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'_> Rem<Fraction> for &'_ Fraction

type Output = Fraction

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'_, '_> Rem<&'_ Fraction> for &'_ Fraction

type Output = Fraction

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<i64> for Fraction

type Output = Fraction

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'_> Rem<&'_ i64> for Fraction

type Output = Fraction

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'_> Rem<i64> for &'_ Fraction

type Output = Fraction

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'_, '_> Rem<&'_ i64> for &'_ Fraction

type Output = Fraction

The resulting type after applying the % operator.

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

Performs the % operation.

impl Sub<Fraction> for Fraction

type Output = Fraction

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'_> Sub<&'_ Fraction> for Fraction

type Output = Fraction

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'_> Sub<Fraction> for &'_ Fraction

type Output = Fraction

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'_, '_> Sub<&'_ Fraction> for &'_ Fraction

type Output = Fraction

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<i64> for Fraction

type Output = Fraction

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'_> Sub<&'_ i64> for Fraction

type Output = Fraction

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'_> Sub<i64> for &'_ Fraction

type Output = Fraction

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'_, '_> Sub<&'_ i64> for &'_ Fraction

type Output = Fraction

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<Fraction> for i64

Attempts to convert a Fraction into a i64. Will return an error if the fraction is not a whole number. If truncation is the goal, first call floor and then either TryFrom or @get_numerator

type Error = String

The type returned in the event of a conversion error.

fn try_from(fraction: Fraction) -> Result<Self, Self::Error>

Performs the conversion.

impl Add<Fraction> for Fraction

type Output = Fraction

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_> Add<&'_ Fraction> for Fraction

type Output = Fraction

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_> Add<Fraction> for &'_ Fraction

type Output = Fraction

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_, '_> Add<&'_ Fraction> for &'_ Fraction

type Output = Fraction

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<i64> for Fraction

type Output = Fraction

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_> Add<&'_ i64> for Fraction

type Output = Fraction

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_> Add<i64> for &'_ Fraction

type Output = Fraction

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_, '_> Add<&'_ i64> for &'_ Fraction

type Output = Fraction

The resulting type after applying the + operator.

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

Performs the + operation.

impl Mul<Fraction> for Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_> Mul<&'_ Fraction> for Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_> Mul<Fraction> for &'_ Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_, '_> Mul<&'_ Fraction> for &'_ Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i64> for Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_> Mul<&'_ i64> for Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_> Mul<i64> for &'_ Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_, '_> Mul<&'_ i64> for &'_ Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Fraction> for Term

type Output = Term

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_> Mul<&'_ Fraction> for Term

type Output = Term

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_> Mul<Fraction> for &'_ Term

type Output = Term

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'_, '_> Mul<&'_ Fraction> for &'_ Term

type Output = Term

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Fraction

type Output = Fraction

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'_> Neg for &'_ Fraction

type Output = Fraction

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Pow<i32> for Fraction

type Output = Fraction

The result after applying the operator.

fn pow(self, rhs: i32) -> Fraction

Returns self to the power rhs.

impl Pow<u32> for Fraction

type Output = Fraction

The result after applying the operator.

fn pow(self, pow: u32) -> Self

Returns self to the power rhs.