Struct hmath::Ratio

pub struct Ratio { /* private fields */ }

Implementations

impl Ratio

pub fn add_rat(&self, other: &Ratio) -> Self

pub fn add_rat_mut(&mut self, other: &Ratio)

pub fn add_bi(&self, other: &BigInt) -> Self

pub fn add_bi_mut(&mut self, other: &BigInt)

pub fn add_i32(&self, other: i32) -> Self

pub fn add_i32_mut(&mut self, other: i32)

impl Ratio

pub fn div_rat(&self, other: &Ratio) -> Self

pub fn div_rat_mut(&mut self, other: &Ratio)

pub fn div_bi(&self, other: &BigInt) -> Self

pub fn div_bi_mut(&mut self, other: &BigInt)

pub fn div_i32(&self, other: i32) -> Self

pub fn div_i32_mut(&mut self, other: i32)

impl Ratio

pub fn mul_rat(&self, other: &Ratio) -> Self

pub fn mul_rat_mut(&mut self, other: &Ratio)

pub fn mul_bi(&self, other: &BigInt) -> Self

pub fn mul_bi_mut(&mut self, other: &BigInt)

pub fn mul_i32(&self, other: i32) -> Self

pub fn mul_i32_mut(&mut self, other: i32)

impl Ratio

pub fn pow_i32(&self, exp: i32) -> Self

pub fn pow_i32_mut(&mut self, exp: i32)

impl Ratio

pub fn sub_rat(&self, other: &Ratio) -> Self

pub fn sub_rat_mut(&mut self, other: &Ratio)

pub fn sub_bi(&self, other: &BigInt) -> Self

pub fn sub_bi_mut(&mut self, other: &BigInt)

pub fn sub_i32(&self, other: i32) -> Self

pub fn sub_i32_mut(&mut self, other: i32)

impl Ratio

pub fn lt_rat(&self, other: &Ratio) -> bool

self < other

pub fn gt_rat(&self, other: &Ratio) -> bool

self > other

pub fn eq_rat(&self, other: &Ratio) -> bool

self == other

pub fn neq_rat(&self, other: &Ratio) -> bool

self != other

pub fn leq_rat(&self, other: &Ratio) -> bool

self <= other

pub fn geq_rat(&self, other: &Ratio) -> bool

self >= other

pub fn comp_rat(&self, other: &Ratio) -> Ordering

pub fn lt_one(&self) -> bool

self < 1

pub fn gt_one(&self) -> bool

self > 1

pub fn lt_i32(&self, other: i32) -> bool

self < other

pub fn gt_i32(&self, other: i32) -> bool

self > other

pub fn eq_i32(&self, other: i32) -> bool

self == other

pub fn neq_i32(&self, other: i32) -> bool

self != other

pub fn leq_i32(&self, other: i32) -> bool

self <= other

pub fn geq_i32(&self, other: i32) -> bool

self >= other

pub fn comp_i32(&self, other: i32) -> Ordering

impl Ratio

pub fn from_ieee754_f32(n: f32) -> Result<Self, ConversionError>

If you don’t know what ieee754 is, you’re okay to use this function. Though the ieee 754 standard distinguishes negative 0 and positive 0, it doesn’t distinguish between them. It returns an error if n is NaN or Inf.

pub fn to_ieee754_f32(&self) -> Result<f32, ConversionError>

If you don’t know what ieee754 is, you’re okay to use this function. This function does not return f32::NAN or f32::INFINITY, but it returns ConversionError::NotInRange instead.

pub fn from_ieee754_f64(n: f64) -> Result<Self, ConversionError>

If you don’t know what ieee754 is, you’re okay to use this function. Though the ieee 754 standard distinguishes negative 0 and positive 0, it doesn’t distinguish between them. It returns an error if n is NaN or Inf.

pub fn to_ieee754_f64(&self) -> Result<f64, ConversionError>

If you don’t know what ieee754 is, you’re okay to use this function. This function does not return f64::NAN or f64::INFINITY, but it returns ConversionError::NotInRange instead.

impl Ratio

pub fn from_denom_and_numer(denom: BigInt, numer: BigInt) -> Self

pub fn from_denom_and_numer_i32(denom: i32, numer: i32) -> Self

pub fn from_denom_and_numer_raw(denom: BigInt, numer: BigInt) -> Self

This function does not do any safety checks. Use this function only when you’re sure that the properties below are satisfied.

• denom and numer are coprime
• denom is positive
• denom is 1 when numer is 0

pub fn from_bi(n: BigInt) -> Self

pub fn from_ubi(n: UBigInt) -> Self

pub fn from_i32(n: i32) -> Self

pub fn from_i64(n: i64) -> Self

pub fn from_i128(n: i128) -> Self

pub fn from_string(s: &str) -> Result<Self, ConversionError>

pub fn to_ratio_string(&self) -> String

Ratio { 4, 7 } -> “4/7”.

pub fn to_approx_string(&self, max_len: usize) -> String

Ratio { 4, 7 } -> “1.75”. The length of the returned string is less or equal to digits. If digits is less than 6, it’ll count that as 6.

pub fn to_scientific_notation(&self, digits_max_len: usize) -> String

‘9.8e5’

pub fn to_string(&self) -> String

self.to_approx_string(12)

impl Ratio

pub fn neg(&self) -> Self

pub fn neg_mut(&mut self)

pub fn abs(&self) -> Self

pub fn abs_mut(&mut self)

pub fn reci(&self) -> Self

1 / self

pub fn reci_mut(&mut self)

self = 1 / self

pub fn truncate(&self) -> Self

pub fn truncate_mut(&mut self)

pub fn truncate_bi(&self) -> BigInt

pub fn frac(&self) -> Self

self - truncate(self)

pub fn frac_mut(&mut self)

self -= truncate(self)

pub fn truncate_and_frac(&self) -> (BigInt, Self)

If you need both self.truncate_bi and self.frac, use this method. It’s way cheaper.

pub fn floor(&self) -> Ratio

It returns the largest integer less than or equal to self.

pub fn floor_bi(&self) -> BigInt

It returns the largest integer less than or equal to self.

impl Ratio

pub fn from_raw( denom: Vec<u32>, denom_neg: bool, numer: Vec<u32>, numer_neg: bool ) -> Self

This function DOES NOT check whether denom and numer are coprime. Avoid using this function except when converting the result of Ratio::into_raw to Ratio. In most cases, it’s safer to use Ratio::from_denom_and_numer.

pub fn into_raw(self) -> (Vec<u32>, bool, Vec<u32>, bool)

pub fn zero() -> Self

pub fn one() -> Self

pub fn is_neg(&self) -> bool

pub fn is_one(&self) -> bool

pub fn is_zero(&self) -> bool

pub fn is_integer(&self) -> bool

pub fn shrink(&mut self, limit: usize) -> Result<usize, usize>

It shrinks the size of self.numer and self.denom until they’re less than or equal to 2^(limit * 32). It may lose accuracy. If denom and numer are already small enough, it returns Ok(0). If it successfully shrinks, it returns Ok(n) where n is how much numbers it removed. Sometimes, the shrinked result doesn’t satisfy the limit. It returns Err(n) in those cases where n is how much numbers it removed.

Trait Implementations

impl Clone for Ratio

fn clone(&self) -> Ratio

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ratio

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

Formats the value using the given formatter.

impl Default for Ratio

fn default() -> Self

Returns the “default value” for a type.

impl Display for Ratio

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

Formats the value using the given formatter.

impl<T: Copy> From<&T> for Ratiowhere Ratio: From<T>,

fn from(n: &T) -> Self

Converts to this type from the input type.

impl From<&str> for Ratio

If it fails to parse the string, it returns 0.

fn from(n: &str) -> Self

Converts to this type from the input type.

impl From<BigInt> for Ratio

fn from(n: BigInt) -> Self

Converts to this type from the input type.

impl From<Ratio> for BigInt

fn from(n: Ratio) -> Self

Converts to this type from the input type.

impl From<Ratio> for UBigInt

fn from(n: Ratio) -> Self

Converts to this type from the input type.

impl From<String> for Ratio

If it fails to parse the string, it returns 0.

fn from(n: String) -> Self

Converts to this type from the input type.

impl From<UBigInt> for Ratio

fn from(n: UBigInt) -> Self

Converts to this type from the input type.

impl From<bool> for Ratio

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Ratio

It returns 0 for NaN, Ratio(f32::MAX) for f32::Inf and Ratio(f32::MIN) for f32::NegInf.

fn from(n: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Ratio

It returns 0 for NaN, Ratio(f64::MAX) for f64::Inf and Ratio(f64::MIN) for f64::NegInf.

fn from(n: f64) -> Self

Converts to this type from the input type.

impl From<i128> for Ratio

fn from(n: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Ratio

fn from(n: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Ratio

fn from(n: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Ratio

fn from(n: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Ratio

fn from(n: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Ratio

fn from(n: isize) -> Self

Converts to this type from the input type.

impl From<u128> for Ratio

fn from(n: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Ratio

fn from(n: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Ratio

fn from(n: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Ratio

fn from(n: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Ratio

fn from(n: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Ratio

fn from(n: usize) -> Self

Converts to this type from the input type.

impl Ord for Ratio

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Ratio> for Ratio

fn eq(&self, other: &Ratio) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Ratio> for Ratio

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

impl StructuralEq for Ratio

impl StructuralPartialEq for Ratio