Struct floating_bar::r64

pub struct r64(_);

The 64-bit floating bar type.

Implementations

impl r64

pub const unsafe fn new_unchecked(numer: i64, denom: u64) -> r64

Creates a rational number without checking the values.

Safety

The values must fit in the fraction field.

pub fn new(numer: i64, denom: u64) -> Option<r64>

Creates a rational number if the given values both fit in the fraction field.

pub fn sqrt(self) -> r64

Calculates the approximate square root of the value.

Warning: This method can give a number that overflows easily, so use it with caution, and discard it as soon as you’re done with it.

pub fn cbrt(self) -> r64

Calculates the approximate cube root of the value.

Warning: This method can give a number that overflows easily, so use it with caution, and discard it as soon as you’re done with it.

pub fn checked_add(self, rhs: r64) -> Option<r64>

Checked rational addition. Computes self + rhs, returning None if overflow occurred.

pub fn checked_mul(self, rhs: r64) -> Option<r64>

Checked rational multiplication. Computes self * rhs, returning None if overflow occurred.

pub fn to_i64(self) -> Option<i64>

Checked conversion to i64.

Returns i64 value if denominator is 1. Otherwise, returns None.

impl r64

pub const MAX: r64

The highest value that can be represented by this rational type.

pub const MIN: r64

The lowest value that can be represented by this rational type.

pub const MIN_POSITIVE: r64

The smallest positive value that can be represented by this rational type.

pub const NAN: r64

Not a Number (NaN).

pub fn is_nan(self) -> bool

Returns true if this value is NAN and false otherwise.

pub fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero, negative, or NAN.

pub fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero, positive, or NAN.

pub fn trunc(self) -> r64

Returns the integer part of a number, or NaN if self is NaN.

pub fn fract(self) -> r64

Returns the fractional part of a number, or NaN if self is NaN.

pub fn floor(self) -> r64

Returns the largest integer less than or equal to a number.

pub fn ceil(self) -> r64

Returns the smallest integer greater than or equal to a number.

pub fn round(self) -> r64

Returns the nearest integer to a number. Round half-way cases away from zero.

pub fn abs(self) -> r64

Computes the absolute value of self.

pub fn signum(self) -> r64

Returns a number that represents the sign of self.

• 1 if the number is positive
• -1 if the number is negative
• 0 if the number is 0
• NAN if the number is NAN.

pub fn recip(self) -> r64

Takes the reciprocal (inverse) of a number, 1/x.

Panics

Panics when the numerator is zero.

pub fn normalize(self) -> r64

Cancels out common factors between the numerator and the denominator.

pub fn pow(self, exp: i32) -> r64

Checked exponentiation. Computes self.pow(exp), returning None if overflow occurred.

pub fn max(self, other: r64) -> r64

Returns the maximum of the two numbers.

If one of the arguments is NaN, then the other argument is returned.

pub fn min(self, other: r64) -> r64

Returns the minimum of the two numbers.

If one of the arguments is NaN, then the other argument is returned.

pub fn checked_neg(self) -> Option<r64>

Checked rational negation. Computes -self, returning None if the numerator would overflow.

pub fn checked_abs(self) -> Option<r64>

Checked absolute value. Computes self.abs(), returning None if the numerator would overflow.

pub fn checked_recip(self) -> Option<r64>

Checked reciprocal. Computes 1/self, returning None if the numerator is zero.

pub fn checked_pow(self, exp: i32) -> Option<r64>

Checked exponentiation. Computes self.pow(exp), returning None if overflow occurred.

pub fn checked_sub(self, rhs: r64) -> Option<r64>

Checked subtraction. Computes self - rhs, returning None if overflow occurred.

pub fn checked_div(self, rhs: r64) -> Option<r64>

Checked rational division. Computes self / rhs, returning None if rhs == 0 or the division results in overflow.

pub fn checked_rem(self, rhs: r64) -> Option<r64>

Checked rational remainder. Computes self % rhs, returning None if rhs == 0 or the division results in overflow.

pub fn to_bits(self) -> u64

Raw transmutation to u64.

Useful if you need access to the payload bits of a NaN value.

pub fn from_bits(bits: u64) -> r64

Raw transmutation from u64.

Trait Implementations

impl Add<r64> for r64

type Output = r64

The resulting type after applying the + operator.

fn add(self, other: r64) -> Self::Output

Performs the + operation.

impl AddAssign<r64> for r64

fn add_assign(&mut self, other: r64)

Performs the += operation.

impl Clone for r64

fn clone(&self) -> r64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for r64

impl Debug for r64

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

Formats the value using the given formatter.

impl Default for r64

fn default() -> r64

Returns the “default value” for a type.

impl Display for r64

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

Formats the value using the given formatter.

impl Div<r64> for r64

type Output = r64

The resulting type after applying the / operator.

fn div(self, other: r64) -> Self::Output

Performs the / operation.

impl DivAssign<r64> for r64

fn div_assign(&mut self, other: r64)

Performs the /= operation.

impl Eq for r64

impl From<f32> for r64

fn from(f: f32) -> Self

Performs the conversion.

impl From<f64> for r64

fn from(f: f64) -> Self

Based on John D. Cook’s Best Rational Approximation post

impl From<i16> for r64

fn from(v: i16) -> Self

Performs the conversion.

impl From<i32> for r64

fn from(v: i32) -> Self

Performs the conversion.

impl From<i8> for r64

fn from(v: i8) -> Self

Performs the conversion.

impl From<r32> for r64

fn from(v: r32) -> Self

Performs the conversion.

impl From<u16> for r64

fn from(v: u16) -> Self

Performs the conversion.

impl From<u32> for r64

fn from(v: u32) -> Self

Performs the conversion.

impl From<u8> for r64

fn from(v: u8) -> Self

Performs the conversion.

impl FromStr for r64

type Err = ParseRatioErr

The associated error which can be returned from parsing.

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

Converts a string in base 10 to a rational.

This function accepts strings such as

• ‘157/50’
• ‘-157/50’
• ‘25’, or equivalently, ‘25/1’
• ‘NaN’

Leading and trailing whitespace represent an error.

Return value

Err(ParseRatioError) if the string did not contain a valid rational number. Otherwise, Ok(n) where n is the floating-bar number represented by src.

impl Mul<r64> for r64

type Output = r64

The resulting type after applying the * operator.

fn mul(self, other: r64) -> Self::Output

Performs the * operation.

impl MulAssign<r64> for r64

fn mul_assign(&mut self, other: r64)

Performs the *= operation.

impl Neg for r64

type Output = r64

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<r64> for r64

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

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

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

This method tests for !=.

impl PartialOrd<r64> for r64

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

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

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

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

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

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

#[must_use]pub 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 Rem<r64> for r64

type Output = r64

The resulting type after applying the % operator.

fn rem(self, other: r64) -> Self::Output

Performs the % operation.

impl RemAssign<r64> for r64

fn rem_assign(&mut self, other: r64)

Performs the %= operation.

impl StructuralEq for r64

impl Sub<r64> for r64

type Output = r64

The resulting type after applying the - operator.

fn sub(self, other: r64) -> Self::Output

Performs the - operation.

impl SubAssign<r64> for r64

fn sub_assign(&mut self, other: r64)

Performs the -= operation.