Struct ramp::rational::Rational

pub struct Rational { /* fields omitted */ }

An arbitrary-precision rational number.

This type is used to represent numbers in the form a / b where a and b are Ints and b is non-zero.

Implementations

impl Rational

pub fn abs(self) -> Rational

Consumes this Rational, returning its absolute value.

pub fn new(n: Int, d: Int) -> Rational

Creates a new Rational from a numerator n and denominator d.

This method normalizes the Rational.

Panics

Panics if d is zero.

pub fn into_parts(self) -> (Int, Int)

Returns the (numerator, denominator) of this Rational in normalized form.

pub fn normalized(&self) -> bool

Returns whether or not this Rational is normalized.

pub fn normalize(&mut self)

Normalize this Rational in place.

This method ensures that the Rational is represented in lowest forms, i.e. as a/b such that a and b share no common factors. It also ensures that the denominator is positive.

Normalizing rationals results in faster calculations, ensuring that the numerator and denominator are as small as possible.

Most of the time, this method is called automatically.

pub fn invert(self) -> Rational

Consumes this Rational, returning its reciprocal.

Panics

Panics if the Rational is zero. This can be checked with the is_zero method.

pub fn round(self) -> Int

Consumes this Rational, rounding it to the nearest Int.

This method will round half values away from zero, similarly to f64::round.

pub fn sign(&self) -> i32

Returns the sign of this Rational as either -1, 0 or 1 depending on whether it is negative, zero, or positive, respectively.

pub fn to_f64(&self) -> f64

Converts this Rational into an f64.

This is not an exact conversion, because this Rational may be more precise than an f64 can account for.

Currently, this conversion is naïve, simply converting the numerator and denominator into f64s and dividing them.

Trait Implementations

impl<'a> Add<&'a Int> for Rational

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: &'a Int) -> Rational

Performs the + operation.

impl<'a, 'b> Add<&'a Int> for &'b Rational

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: &'a Int) -> Rational

Performs the + operation.

impl<'a> Add<&'a Rational> for Rational

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: &'a Rational) -> Rational

Performs the + operation.

impl<'a, 'b> Add<&'a Rational> for &'b Rational

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: &'a Rational) -> Rational

Performs the + operation.

impl<'a> Add<&'a Rational> for Int

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: &'a Rational) -> Rational

Performs the + operation.

impl<'a, 'b> Add<&'a Rational> for &'b Int

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: &'a Rational) -> Rational

Performs the + operation.

impl Add<Int> for Rational

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: Int) -> Rational

Performs the + operation.

impl<'a> Add<Int> for &'a Rational

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: Int) -> Rational

Performs the + operation.

impl Add<Rational> for Rational

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: Rational) -> Rational

Performs the + operation.

impl<'a> Add<Rational> for &'a Rational

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: Rational) -> Rational

Performs the + operation.

impl Add<Rational> for Int

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: Rational) -> Rational

Performs the + operation.

impl<'a> Add<Rational> for &'a Int

type Output = Rational

The resulting type after applying the + operator.

fn add(self, other: Rational) -> Rational

Performs the + operation.

impl<'a> AddAssign<&'a Int> for Rational

fn add_assign(&mut self, other: &'a Int)

Performs the += operation.

impl<'a> AddAssign<&'a Rational> for Rational

fn add_assign(&mut self, other: &'a Rational)

Performs the += operation.

impl AddAssign<Int> for Rational

fn add_assign(&mut self, other: Int)

Performs the += operation.

impl AddAssign<Rational> for Rational

fn add_assign(&mut self, other: Rational)

Performs the += operation.

impl Clone for Rational

fn clone(&self) -> Rational

Returns a copy of the value.

fn clone_from(&mut self, other: &Rational)

Performs copy-assignment from source.

impl Debug for Rational

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

Formats the value using the given formatter.

impl Default for Rational

fn default() -> Rational

Returns the "default value" for a type.

impl Display for Rational

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

Formats the value using the given formatter.

impl<'a> Div<&'a Int> for Rational

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: &'a Int) -> Rational

Performs the / operation.

impl<'a, 'b> Div<&'a Int> for &'b Rational

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: &'a Int) -> Rational

Performs the / operation.

impl<'a> Div<&'a Rational> for Rational

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: &'a Rational) -> Rational

Performs the / operation.

impl<'a, 'b> Div<&'a Rational> for &'b Rational

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: &'a Rational) -> Rational

Performs the / operation.

impl<'a> Div<&'a Rational> for Int

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: &'a Rational) -> Rational

Performs the / operation.

impl<'a, 'b> Div<&'a Rational> for &'b Int

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: &'a Rational) -> Rational

Performs the / operation.

impl Div<Int> for Rational

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: Int) -> Rational

Performs the / operation.

impl<'a> Div<Int> for &'a Rational

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: Int) -> Rational

Performs the / operation.

impl Div<Rational> for Rational

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: Rational) -> Rational

Performs the / operation.

impl<'a> Div<Rational> for &'a Rational

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: Rational) -> Rational

Performs the / operation.

impl Div<Rational> for Int

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: Rational) -> Rational

Performs the / operation.

impl<'a> Div<Rational> for &'a Int

type Output = Rational

The resulting type after applying the / operator.

fn div(self, other: Rational) -> Rational

Performs the / operation.

impl<'a> DivAssign<&'a Int> for Rational

fn div_assign(&mut self, other: &'a Int)

Performs the /= operation.

impl<'a> DivAssign<&'a Rational> for Rational

fn div_assign(&mut self, other: &'a Rational)

Performs the /= operation.

impl DivAssign<Int> for Rational

fn div_assign(&mut self, other: Int)

Performs the /= operation.

impl DivAssign<Rational> for Rational

fn div_assign(&mut self, other: Rational)

Performs the /= operation.

impl Eq for Rational

impl<U: Into<Int>> From<U> for Rational

fn from(val: U) -> Rational

Performs the conversion.

impl From<f32> for Rational

fn from(val: f32) -> Rational

Performs the conversion.

impl From<f64> for Rational

fn from(val: f64) -> Rational

Performs the conversion.

impl FromStr for Rational

type Err = ParseRationalError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Rational, ParseRationalError>

Parses a string s to return a value of this type.

impl Hash for Rational

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<'a> Mul<&'a Int> for Rational

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: &'a Int) -> Rational

Performs the * operation.

impl<'a, 'b> Mul<&'a Int> for &'b Rational

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: &'a Int) -> Rational

Performs the * operation.

impl<'a> Mul<&'a Rational> for Rational

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: &'a Rational) -> Rational

Performs the * operation.

impl<'a, 'b> Mul<&'a Rational> for &'b Rational

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: &'a Rational) -> Rational

Performs the * operation.

impl<'a> Mul<&'a Rational> for Int

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: &'a Rational) -> Rational

Performs the * operation.

impl<'a, 'b> Mul<&'a Rational> for &'b Int

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: &'a Rational) -> Rational

Performs the * operation.

impl Mul<Int> for Rational

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: Int) -> Rational

Performs the * operation.

impl<'a> Mul<Int> for &'a Rational

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: Int) -> Rational

Performs the * operation.

impl Mul<Rational> for Rational

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: Rational) -> Rational

Performs the * operation.

impl<'a> Mul<Rational> for &'a Rational

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: Rational) -> Rational

Performs the * operation.

impl Mul<Rational> for Int

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: Rational) -> Rational

Performs the * operation.

impl<'a> Mul<Rational> for &'a Int

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, other: Rational) -> Rational

Performs the * operation.

impl<'a> MulAssign<&'a Int> for Rational

fn mul_assign(&mut self, other: &'a Int)

Performs the *= operation.

impl<'a> MulAssign<&'a Rational> for Rational

fn mul_assign(&mut self, other: &'a Rational)

Performs the *= operation.

impl MulAssign<Int> for Rational

fn mul_assign(&mut self, other: Int)

Performs the *= operation.

impl MulAssign<Rational> for Rational

fn mul_assign(&mut self, other: Rational)

Performs the *= operation.

impl Neg for Rational

type Output = Rational

The resulting type after applying the - operator.

fn neg(self) -> Rational

Performs the unary - operation.

impl<'a> Neg for &'a Rational

type Output = Rational

The resulting type after applying the - operator.

fn neg(self) -> Rational

Performs the unary - operation.

impl One for Rational

fn one() -> Rational

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl Ord for Rational

fn cmp(&self, other: &Rational) -> Ordering

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

#[must_use]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<Int> for Rational

fn eq(&self, other: &Int) -> 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 PartialEq<Rational> for Rational

fn eq(&self, other: &Rational) -> 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 PartialEq<Rational> for Int

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

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

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

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

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

#[must_use]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]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 PartialOrd<Rational> for Rational

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

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

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

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

#[must_use]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]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 PartialOrd<Rational> for Int

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

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

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

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

#[must_use]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]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<'a> Sub<&'a Rational> for Rational

type Output = Rational

The resulting type after applying the - operator.

fn sub(self, other: &'a Rational) -> Rational

Performs the - operation.

impl<'a, 'b> Sub<&'a Rational> for &'b Rational

type Output = Rational

The resulting type after applying the - operator.

fn sub(self, other: &'a Rational) -> Rational

Performs the - operation.

impl Sub<Rational> for Rational

type Output = Rational

The resulting type after applying the - operator.

fn sub(self, other: Rational) -> Rational

Performs the - operation.

impl<'a> Sub<Rational> for &'a Rational

type Output = Rational

The resulting type after applying the - operator.

fn sub(self, other: Rational) -> Rational

Performs the - operation.

impl<'a> SubAssign<&'a Rational> for Rational

fn sub_assign(&mut self, other: &'a Rational)

Performs the -= operation.

impl SubAssign<Rational> for Rational

fn sub_assign(&mut self, other: Rational)

Performs the -= operation.

impl Zero for Rational

fn zero() -> Rational

Returns the additive identity element of Self, 0. # Purity

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.