Struct ketos::integer::Ratio

pub struct Ratio(_);

Arbitrary precision signed integer ratio

Methods

impl Ratio

pub fn new(numer: Integer, denom: Integer) -> Ratio

Constructs a Ratio from numerator and denominator.

Panics

Panics if denom is zero.

pub fn from_f32(f: f32) -> Option<Ratio>

Creates a Ratio with the value of the given f32. Returns None if the value cannot be converted.

pub fn from_f64(f: f64) -> Option<Ratio>

Creates a Ratio with the value of the given f64. Returns None if the value cannot be converted.

pub fn from_integer(i: Integer) -> Ratio

Creates a Ratio from an Integer value.

pub fn to_f32(&self) -> Option<f32>

Returns the Ratio as an f32 value.

pub fn to_f64(&self) -> Option<f64>

Returns the Ratio as an f64 value.

pub fn to_integer(&self) -> Integer

Truncates a Ratio and returns the whole portion as an Integer.

pub fn is_integer(&self) -> bool

Returns whether the Ratio is an integer; i.e. its denominator is 1.

pub fn abs(&self) -> Ratio

Returns the absolute value of the Ratio.

pub fn ceil(&self) -> Ratio

Returns the Ratio rounded towards positive infinity.

pub fn floor(&self) -> Ratio

Returns the Ratio rounded towards negative infinity.

pub fn fract(&self) -> Ratio

Returns the fractional portion of a Ratio.

pub fn round(&self) -> Ratio

Returns the Ratio rounded to the nearest integer. Rounds half-way cases away from zero.

pub fn trunc(&self) -> Ratio

Returns the Ratio rounded towards zero.

pub fn recip(&self) -> Ratio

Returns the reciprocal of a Ratio.

Panics

Panics if the numerator is zero.

pub fn numer(&self) -> &Integer

Returns the Ratio's numerator.

pub fn denom(&self) -> &Integer

Returns the Ratio's denominator.

pub fn is_zero(&self) -> bool

Returns whether the Ratio is equal to zero.

pub fn is_negative(&self) -> bool

Returns whether the Ratio is less than zero.

pub fn is_positive(&self) -> bool

Returns whether the Ratio is greater than zero.

pub fn zero() -> Ratio

Returns a Ratio of value zero.

pub fn one() -> Ratio

Returns a Ratio of value one.

Trait Implementations

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

type Output = Ratio

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Ratio

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Ratio> for Ratio

type Output = Ratio

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Ratio

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

impl AddAssign<Ratio> for Ratio

fn add_assign(&mut self, rhs: Ratio)

Performs the += operation.

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 Display for Ratio

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

Formats the value using the given formatter.

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

type Output = Ratio

The resulting type after applying the / operator.

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

Performs the / operation.

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

type Output = Ratio

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Ratio> for Ratio

type Output = Ratio

The resulting type after applying the / operator.

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

Performs the / operation.

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

type Output = Ratio

The resulting type after applying the / operator.

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

Performs the / operation.

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

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

Performs the /= operation.

impl DivAssign<Ratio> for Ratio

fn div_assign(&mut self, rhs: Ratio)

Performs the /= operation.

impl Eq for Ratio

impl From<Ratio> for Value

fn from(r: Ratio) -> Value

Performs the conversion.

impl FromStr for Ratio

type Err = FromStrRatioError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Ratio, FromStrRatioError>

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

impl FromValue for Ratio

fn from_value(v: Value) -> Result<Ratio, ExecError>

Consumes the Value and returns a Rust value

impl<'a> FromValueRef<'a> for &'a Ratio

fn from_value_ref(v: &'a Value) -> Result<&'a Ratio, ExecError>

Returns the borrowed value

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

type Output = Ratio

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Ratio

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Ratio> for Ratio

type Output = Ratio

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Ratio

The resulting type after applying the * operator.

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

Performs the * operation.

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

fn mul_assign(&mut self, rhs: &Ratio)

Performs the *= operation.

impl MulAssign<Ratio> for Ratio

fn mul_assign(&mut self, rhs: Ratio)

Performs the *= operation.

impl Neg for Ratio

type Output = Ratio

The resulting type after applying the - operator.

fn neg(self) -> Ratio

Performs the unary - operation.

impl<'a> Neg for &'a Ratio

type Output = Ratio

The resulting type after applying the - operator.

fn neg(self) -> Ratio

Performs the unary - operation.

impl Ord for Ratio

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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<Integer> for Ratio

fn eq(&self, rhs: &Integer) -> 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<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: &Ratio) -> bool

This method tests for !=.

impl PartialEq<Ratio> for Integer

fn eq(&self, rhs: &Ratio) -> 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<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: &Ratio) -> bool

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

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

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

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

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

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

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

impl<'a> Rem<&'a Ratio> for Ratio

type Output = Ratio

The resulting type after applying the % operator.

fn rem(self, rhs: &Ratio) -> Ratio

Performs the % operation.

impl<'a, 'b> Rem<&'b Ratio> for &'a Ratio

type Output = Ratio

The resulting type after applying the % operator.

fn rem(self, rhs: &Ratio) -> Ratio

Performs the % operation.

impl Rem<Ratio> for Ratio

type Output = Ratio

The resulting type after applying the % operator.

fn rem(self, rhs: Ratio) -> Ratio

Performs the % operation.

impl<'a> Rem<Ratio> for &'a Ratio

type Output = Ratio

The resulting type after applying the % operator.

fn rem(self, rhs: Ratio) -> Ratio

Performs the % operation.

impl<'a> RemAssign<&'a Ratio> for Ratio

fn rem_assign(&mut self, rhs: &Ratio)

Performs the %= operation.

impl RemAssign<Ratio> for Ratio

fn rem_assign(&mut self, rhs: Ratio)

Performs the %= operation.

impl StructuralEq for Ratio

impl StructuralPartialEq for Ratio

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

type Output = Ratio

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Ratio

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Ratio> for Ratio

type Output = Ratio

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Ratio

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

impl SubAssign<Ratio> for Ratio

fn sub_assign(&mut self, rhs: Ratio)

Performs the -= operation.

impl Zero for Ratio

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn zero() -> Ratio

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

fn set_zero(&mut self)

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