Struct Rational 

pub struct Rational(/* private fields */);

An arbitrary-precision exact rational number, always kept in lowest terms.

It supports the usual arithmetic (+ - * /, on values and references), comparisons, Display (3/2, -4, never a decimal) and parsing from the same notation.

use simplex_trace::{Rational, ratio};

let a = ratio(3, 2);
let b: Rational = "7/4".parse().unwrap();
let c = Rational::from(5);
let d = &a + &b * c;
assert_eq!(d, ratio(41, 4));
assert_eq!(d.to_string(), "41/4");
assert_eq!(d.to_i64_parts(), Some((41, 4)));
assert_eq!(d.to_f64(), 10.25);

The representation is an implementation detail, so the crate can change it (for example to speed up small numbers) without breaking users. With the num-interop feature it converts to and from num_rational::BigRational.

With the serde feature it is a JSON string such as "3/2". JSON numbers are rejected, so nothing is ever rounded.

Implementations

impl Rational

pub fn new(numer: i64, denom: i64) -> Self

The fraction numer / denom, reduced. Panics if denom == 0.

pub fn zero() -> Self

pub fn one() -> Self

pub fn is_zero(&self) -> bool

pub fn is_positive(&self) -> bool

pub fn is_negative(&self) -> bool

pub fn is_integer(&self) -> bool

true when the denominator is 1.

pub fn abs(&self) -> Self

pub fn to_i64_parts(&self) -> Option<(i64, i64)>

Numerator and (positive) denominator in lowest terms, if both fit in an i64: for example to draw a stacked fraction.

pub fn to_f64(&self) -> f64

The nearest f64, for display or plotting only; computations should stay exact.

impl Rational

pub fn as_big_rational(&self) -> &BigRational

The underlying num_rational::BigRational.

Trait Implementations

impl Add for Rational

type Output = Rational

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Rational> for Rational

type Output = Rational

The resulting type after applying the + operator.

fn add(self, rhs: &Rational) -> Rational

Performs the + operation.

impl Add<&Rational> for &Rational

type Output = Rational

The resulting type after applying the + operator.

fn add(self, rhs: &Rational) -> Rational

Performs the + operation.

impl Add<Rational> for &Rational

type Output = Rational

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Rational

fn add_assign(&mut self, rhs: Rational)

Performs the += operation.

impl AddAssign<&Rational> for Rational

fn add_assign(&mut self, rhs: &Rational)

Performs the += operation.

impl Clone for Rational

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rational

Same as Display: 3/2.

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

Formats the value using the given formatter.

impl Default for Rational

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Rational

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Rational

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

Formats the value using the given formatter.

impl Div for Rational

type Output = Rational

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Rational> for Rational

type Output = Rational

The resulting type after applying the / operator.

fn div(self, rhs: &Rational) -> Rational

Performs the / operation.

impl Div<&Rational> for &Rational

type Output = Rational

The resulting type after applying the / operator.

fn div(self, rhs: &Rational) -> Rational

Performs the / operation.

impl Div<Rational> for &Rational

type Output = Rational

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for Rational

fn div_assign(&mut self, rhs: Rational)

Performs the /= operation.

impl DivAssign<&Rational> for Rational

fn div_assign(&mut self, rhs: &Rational)

Performs the /= operation.

impl Eq for Rational

impl From<Ratio<BigInt>> for Rational

Available on crate feature num-interop only.

fn from(r: BigRational) -> Self

Converts to this type from the input type.

impl From<Rational> for BigRational

Available on crate feature num-interop only.

fn from(r: Rational) -> Self

Converts to this type from the input type.

impl From<i32> for Rational

fn from(n: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Rational

fn from(n: i64) -> Self

Converts to this type from the input type.

impl FromStr for Rational

Parses n or n/d (integers, d != 0), such as "3", "-1/2". Decimals such as "0.5" are rejected: write "1/2".

type Err = ParseRationalError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Rational

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoRational for Rational

fn into_rational(self) -> Rational

impl Mul for Rational

type Output = Rational

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Rational> for Rational

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, rhs: &Rational) -> Rational

Performs the * operation.

impl Mul<&Rational> for &Rational

type Output = Rational

The resulting type after applying the * operator.

fn mul(self, rhs: &Rational) -> Rational

Performs the * operation.

impl Mul<Rational> for &Rational

type Output = Rational

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Rational

fn mul_assign(&mut self, rhs: Rational)

Performs the *= operation.

impl MulAssign<&Rational> for Rational

fn mul_assign(&mut self, rhs: &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 Neg for &Rational

type Output = Rational

The resulting type after applying the - operator.

fn neg(self) -> Rational

Performs the unary - operation.

impl Ord for Rational

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Rational

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Rational

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Rational

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Rational

impl Sub for Rational

type Output = Rational

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Rational> for Rational

type Output = Rational

The resulting type after applying the - operator.

fn sub(self, rhs: &Rational) -> Rational

Performs the - operation.

impl Sub<&Rational> for &Rational

type Output = Rational

The resulting type after applying the - operator.

fn sub(self, rhs: &Rational) -> Rational

Performs the - operation.

impl Sub<Rational> for &Rational

type Output = Rational

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Rational

fn sub_assign(&mut self, rhs: Rational)

Performs the -= operation.

impl SubAssign<&Rational> for Rational

fn sub_assign(&mut self, rhs: &Rational)

Performs the -= operation.

impl Sum for Rational

fn sum<I: Iterator<Item = Rational>>(iter: I) -> Rational

Takes an iterator and generates Self from the elements by “summing up” the items.

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

fn sum<I: Iterator<Item = &'a Rational>>(iter: I) -> Rational

Takes an iterator and generates Self from the elements by “summing up” the items.