Struct num_decimal::Num

pub struct Num(_);

An unlimited precision number type with some improvements and customizations over BigRational.

Implementations

impl Num

pub fn new<T, U>(numer: T, denom: U) -> Self where
    BigInt: From<T>,
    BigInt: From<U>, 

Construct a Num from two integers.

pub fn round(&self) -> Self

Round the given Num to the nearest integer.

Rounding happens based on the Round-Half-To-Even scheme (also known as the "bankers rounding" algorithm), which rounds to the closest integer as expected but if the fractional part is exactly 1/2 (i.e., equidistant from two integers) it rounds to the even one of the two.

pub fn round_with(&self, precision: usize) -> Self

Round the given Num with the given precision.

Rounding happens based on the Round-Half-To-Even scheme similar to round.

pub fn trunc(&self) -> Self

Round the given Num towards zero.

pub fn fract(&self) -> Self

Return the fractional part of the given Num, with division rounded towards zero.

pub fn to_integer(&self) -> BigInt

Convert the given Num to an integer, rounding towards zero.

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

Convert the given Num into a u64.

The value will be converted into an integer, with rounding towards zero. None is returned if the resulting integer does not fit into 64 bit.

pub fn to_u64(&self) -> Option<u64>

Convert the given Num into a u64.

The value will be converted into an integer, with rounding towards zero. None is returned if the resulting integer does not fit into 64 bit.

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

Convert the given Num into a f64.

None is returned if the numerator or the denominator cannot be converted into an f64.

pub fn is_zero(&self) -> bool

Check if the given Num is zero.

pub fn is_positive(&self) -> bool

Check if the given Num is positive.

pub fn is_negative(&self) -> bool

Check if the given Num is negative.

pub fn display(&self) -> CustomDisplay

Retrieve a display adapter that can be used for some more elaborate formatting needs.

Trait Implementations

impl<'_> Add<&'_ Num> for Num

type Output = Num

The resulting type after applying the + operator.

fn add(self, rhs: &Num) -> Self::Output

Performs the + operation.

impl<'_, '_> Add<&'_ Num> for &'_ Num

type Output = Num

The resulting type after applying the + operator.

fn add(self, rhs: &Num) -> Self::Output

Performs the + operation.

impl Add<Num> for Num

type Output = Num

The resulting type after applying the + operator.

fn add(self, rhs: Num) -> Self::Output

Performs the + operation.

impl<'_> Add<Num> for &'_ Num

type Output = Num

The resulting type after applying the + operator.

fn add(self, rhs: Num) -> Self::Output

Performs the + operation.

impl<T> Add<T> for Num where
    BigInt: From<T>, 

type Output = Num

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<'_, T> Add<T> for &'_ Num where
    BigInt: From<T>, 

type Output = Num

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<'_> AddAssign<&'_ Num> for Num

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

Performs the += operation.

impl AddAssign<Num> for Num

fn add_assign(&mut self, rhs: Num)

Performs the += operation.

impl<T> AddAssign<T> for Num where
    BigInt: From<T>, 

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for Num

fn clone(&self) -> Num

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Num

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

Formats the value using the given formatter.

impl Default for Num

fn default() -> Self

Returns the "default value" for a type.

impl Display for Num

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

Formats the value using the given formatter.

impl<'_> Div<&'_ Num> for Num

type Output = Num

The resulting type after applying the / operator.

fn div(self, rhs: &Num) -> Self::Output

Performs the / operation.

impl<'_, '_> Div<&'_ Num> for &'_ Num

type Output = Num

The resulting type after applying the / operator.

fn div(self, rhs: &Num) -> Self::Output

Performs the / operation.

impl Div<Num> for Num

type Output = Num

The resulting type after applying the / operator.

fn div(self, rhs: Num) -> Self::Output

Performs the / operation.

impl<'_> Div<Num> for &'_ Num

type Output = Num

The resulting type after applying the / operator.

fn div(self, rhs: Num) -> Self::Output

Performs the / operation.

impl<T> Div<T> for Num where
    BigInt: From<T>, 

type Output = Num

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<'_, T> Div<T> for &'_ Num where
    BigInt: From<T>, 

type Output = Num

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<'_> DivAssign<&'_ Num> for Num

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

Performs the /= operation.

impl DivAssign<Num> for Num

fn div_assign(&mut self, rhs: Num)

Performs the /= operation.

impl<T> DivAssign<T> for Num where
    BigInt: From<T>, 

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl Eq for Num

impl From<BigInt> for Num

fn from(val: BigInt) -> Self

Performs the conversion.

impl From<i128> for Num

fn from(val: i128) -> Self

Performs the conversion.

impl From<i16> for Num

fn from(val: i16) -> Self

Performs the conversion.

impl From<i32> for Num

fn from(val: i32) -> Self

Performs the conversion.

impl From<i64> for Num

fn from(val: i64) -> Self

Performs the conversion.

impl From<i8> for Num

fn from(val: i8) -> Self

Performs the conversion.

impl From<isize> for Num

fn from(val: isize) -> Self

Performs the conversion.

impl From<u128> for Num

fn from(val: u128) -> Self

Performs the conversion.

impl From<u16> for Num

fn from(val: u16) -> Self

Performs the conversion.

impl From<u32> for Num

fn from(val: u32) -> Self

Performs the conversion.

impl From<u64> for Num

fn from(val: u64) -> Self

Performs the conversion.

impl From<u8> for Num

fn from(val: u8) -> Self

Performs the conversion.

impl From<usize> for Num

fn from(val: usize) -> Self

Performs the conversion.

impl FromStr for Num

type Err = ParseNumError

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 Num

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, 

Feeds a slice of this type into the given [Hasher].

impl<'_> Mul<&'_ Num> for Num

type Output = Num

The resulting type after applying the * operator.

fn mul(self, rhs: &Num) -> Self::Output

Performs the * operation.

impl<'_, '_> Mul<&'_ Num> for &'_ Num

type Output = Num

The resulting type after applying the * operator.

fn mul(self, rhs: &Num) -> Self::Output

Performs the * operation.

impl Mul<Num> for Num

type Output = Num

The resulting type after applying the * operator.

fn mul(self, rhs: Num) -> Self::Output

Performs the * operation.

impl<'_> Mul<Num> for &'_ Num

type Output = Num

The resulting type after applying the * operator.

fn mul(self, rhs: Num) -> Self::Output

Performs the * operation.

impl<T> Mul<T> for Num where
    BigInt: From<T>, 

type Output = Num

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<'_, T> Mul<T> for &'_ Num where
    BigInt: From<T>, 

type Output = Num

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<'_> MulAssign<&'_ Num> for Num

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

Performs the *= operation.

impl MulAssign<Num> for Num

fn mul_assign(&mut self, rhs: Num)

Performs the *= operation.

impl<T> MulAssign<T> for Num where
    BigInt: From<T>, 

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl Neg for Num

type Output = Num

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'_> Neg for &'_ Num

type Output = Num

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Num

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]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<Num> for Num

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

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

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

This method tests for !=.

impl PartialOrd<Num> for Num

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

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

fn lt(&self, other: &Num) -> bool

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

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

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

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

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

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

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

impl<'_> Rem<&'_ Num> for Num

type Output = Num

The resulting type after applying the % operator.

fn rem(self, rhs: &Num) -> Self::Output

Performs the % operation.

impl<'_, '_> Rem<&'_ Num> for &'_ Num

type Output = Num

The resulting type after applying the % operator.

fn rem(self, rhs: &Num) -> Self::Output

Performs the % operation.

impl Rem<Num> for Num

type Output = Num

The resulting type after applying the % operator.

fn rem(self, rhs: Num) -> Self::Output

Performs the % operation.

impl<'_> Rem<Num> for &'_ Num

type Output = Num

The resulting type after applying the % operator.

fn rem(self, rhs: Num) -> Self::Output

Performs the % operation.

impl<T> Rem<T> for Num where
    BigInt: From<T>, 

type Output = Num

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<'_, T> Rem<T> for &'_ Num where
    BigInt: From<T>, 

type Output = Num

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<'_> RemAssign<&'_ Num> for Num

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

Performs the %= operation.

impl RemAssign<Num> for Num

fn rem_assign(&mut self, rhs: Num)

Performs the %= operation.

impl<T> RemAssign<T> for Num where
    BigInt: From<T>, 

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl StructuralEq for Num

impl StructuralPartialEq for Num

impl<'_> Sub<&'_ Num> for Num

type Output = Num

The resulting type after applying the - operator.

fn sub(self, rhs: &Num) -> Self::Output

Performs the - operation.

impl<'_, '_> Sub<&'_ Num> for &'_ Num

type Output = Num

The resulting type after applying the - operator.

fn sub(self, rhs: &Num) -> Self::Output

Performs the - operation.

impl Sub<Num> for Num

type Output = Num

The resulting type after applying the - operator.

fn sub(self, rhs: Num) -> Self::Output

Performs the - operation.

impl<'_> Sub<Num> for &'_ Num

type Output = Num

The resulting type after applying the - operator.

fn sub(self, rhs: Num) -> Self::Output

Performs the - operation.

impl<T> Sub<T> for Num where
    BigInt: From<T>, 

type Output = Num

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<'_, T> Sub<T> for &'_ Num where
    BigInt: From<T>, 

type Output = Num

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<'_> SubAssign<&'_ Num> for Num

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

Performs the -= operation.

impl SubAssign<Num> for Num

fn sub_assign(&mut self, rhs: Num)

Performs the -= operation.

impl<T> SubAssign<T> for Num where
    BigInt: From<T>, 

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.