Struct extended_rational::URational

pub struct URational { /* fields omitted */ }

A type representing an unsigned projectively-extended rational number

Subtracting a large number from a smaller one always returns 0 unless the larger number is ∞.

Examples

use extended_rational::URational;

let a = URational::new(3, 17);
let b = URational::new(4, 7);

assert_eq!(a+b, URational::new(89, 119));

Use the uratio! macro for more convenient use.

let a = uratio!(3, 17);
let b = uratio!(4, 7);

Or for easy conversions from primitive types.

let a = uratio!(343.863);
let b = uratio!(2u8);

Methods

impl URational

fn new(numerator: u64, denominator: u64) -> URational

Create a new unsigned rational with the given numerator and denominator.

fn numerator(self) -> u64

Returns the numerator of this rational.

fn numerator_mut(&mut self) -> &mut u64

Returns the numerator of this rational mutably.

fn denominator(self) -> u64

Returns the denominator of this rational.

fn denominator_mut(&mut self) -> &mut u64

Returns the denominator of this rational mutably.

fn min_value() -> URational

Returns the smallest value an unsigned rational can store.

fn min_pos_value() -> URational

Returns the smallest non-zero value an unsigned rational can store.

fn max_value() -> URational

Returns the largest value an unsigned rational can store.

fn nan() -> URational

Returns an unsigned rational representing NaN.

fn zero() -> URational

Returns an unsigned rational representing 0.

fn infinity() -> URational

Returns an unsigned rational representing ∞.

fn one() -> URational

Returns an unsigned rational representing 1.

fn is_nan(self) -> bool

Returns true if this rational is NaN and false otherwise.

fn is_zero(self) -> bool

Returns true if this rational is 0 and false otherwise.

fn is_infinity(self) -> bool

Returns true if this rational is ∞ and false otherwise.

fn is_signed(self) -> bool

Returns true if this rational is a signed number (not NaN, 0, or ∞) and false otherwise.

fn reciprocal(self) -> URational

Returns the reciprocal of this rational.

fn complexity(self) -> u64

Returns the complexity of this rational (max of numerator and denominator).

fn floor(self) -> URational

Returns this rational with no fractional component by rounding down.

fn round(self) -> URational

Returns this rational with no fractional component by rounding.

fn ceil(self) -> URational

Returns this rational with no fractional component by rounding up.

fn add_exact(self, other: URational) -> Option<URational>

Computes self + other, returning None if rounding occurred.

fn sub_exact(self, other: URational) -> Option<URational>

Computes self - other, returning None if rounding occurred.

fn mul_exact(self, other: URational) -> Option<URational>

Computes self * other, returning None if rounding occurred.

fn div_exact(self, other: URational) -> Option<URational>

Computes self / other, returning None if rounding occurred.

fn rem_exact(self, other: URational) -> Option<URational>

Computes self % other, returning None if rounding occurred.

Trait Implementations

impl Copy for URational

impl Clone for URational

fn clone(&self) -> URational

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for URational

fn default() -> URational

Returns the "default value" for a type.

impl PartialEq for URational

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

fn partial_cmp(&self, other: &URational) -> 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 Display for URational

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

Formats the rational.

Style

• NaN, ∞, and whole numbers are written directly
• Ratios with complexities less than 100 are written as fractions (n/d)
• All other numbers are written as decimals

impl Debug for URational

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

Formats the rational.

Style

All numbers are written as fractions in parentheses (n/d)

impl AddAssign for URational

fn add_assign(&mut self, other: URational)

Performs the += operation.

impl Add for URational

type Output = URational

The resulting type after applying the + operator.

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

Performs the + operation.

impl SubAssign for URational

fn sub_assign(&mut self, other: URational)

Performs the -= operation.

impl Sub for URational

type Output = URational

The resulting type after applying the - operator.

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

Performs the - operation.

impl MulAssign for URational

fn mul_assign(&mut self, other: URational)

Performs the *= operation.

impl Mul for URational

type Output = URational

The resulting type after applying the * operator.

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

Performs the * operation.

impl DivAssign for URational

fn div_assign(&mut self, other: URational)

Performs the /= operation.

impl Div for URational

type Output = URational

The resulting type after applying the / operator.

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

Performs the / operation.

impl RemAssign for URational

fn rem_assign(&mut self, other: URational)

Performs the %= operation.

impl Rem for URational

type Output = URational

The resulting type after applying the % operator.

fn rem(self, other: URational) -> URational

Performs the % operation.

impl From<u64> for URational

fn from(n: u64) -> URational

Create a new unsigned rational with the given value.

impl From<(u64, u64)> for URational

fn from(tuple: (u64, u64)) -> URational

Create a new unsigned rational with the given numerator and denominator tuple.

impl From<[u64; 2]> for URational

fn from(array: [u64; 2]) -> URational

Create a new unsigned rational with the given numerator and denominator array.

impl From<u32> for URational

fn from(n: u32) -> URational

Create a new unsigned rational with the given value.

impl From<(u32, u32)> for URational

fn from(tuple: (u32, u32)) -> URational

Create a new unsigned rational with the given numerator and denominator tuple.

impl From<[u32; 2]> for URational

fn from(array: [u32; 2]) -> URational

Create a new unsigned rational with the given numerator and denominator array.

impl From<u16> for URational

fn from(n: u16) -> URational

Create a new unsigned rational with the given value.

impl From<(u16, u16)> for URational

fn from(tuple: (u16, u16)) -> URational

Create a new unsigned rational with the given numerator and denominator tuple.

impl From<[u16; 2]> for URational

fn from(array: [u16; 2]) -> URational

Create a new unsigned rational with the given numerator and denominator array.

impl From<u8> for URational

fn from(n: u8) -> URational

Create a new unsigned rational with the given value.

impl From<(u8, u8)> for URational

fn from(tuple: (u8, u8)) -> URational

Create a new unsigned rational with the given numerator and denominator tuple.

impl From<[u8; 2]> for URational

fn from(array: [u8; 2]) -> URational

Create a new unsigned rational with the given numerator and denominator array.