Struct fixed_unsigned::FixedUnsigned

pub struct FixedUnsigned<S> where
    S: FixedScale,  { /* fields omitted */ }

A fixed point unsigned integer

This is a num_bigint::BigUint with a fixed scale.

The fixed scale is determined by the generic S which implements FixedScale and provides the constant FixedScale::SCALE.

Methods

impl<S> FixedUnsigned<S> where
    S: FixedScale, 

pub fn int_part(&self) -> BigUint

Returns the integer part as BigUint (i.e. the part before the decimal point)

pub fn frac_part(&self) -> BigUint

pub fn scale(&self) -> u64

Returns the scale of the FixedUnsigned as u64.

Note that the scale is fixed by type, so for a FixedUnsigned<S> you can also get it as constant by S::Scale. This function is only for convenience.

pub fn from_bytes_be(bytes: &[u8]) -> Self

pub fn from_bytes_le(bytes: &[u8]) -> Self

pub fn to_bytes_be(&self) -> Vec<u8>

pub fn to_bytes_le(&self) -> Vec<u8>

pub fn to_radix_string(&self, radix: u8, uppercase: bool) -> String

Converts the FixedUnsigned to a string representation in base radix.

Panics

This function will panic if the radix is 0 or greater than 36.

pub fn from_radix_string(string: &str, radix: u8) -> Result<Self, ParseError>

Converts a string representation to a FixedUnsigned with base radix.

NOTE: This function always rounds down.

Panics

This function will panic if the radix is 0 or greater than 36.

pub fn into_biguint(self) -> BigUint

Converts to a BigUint losing the decimal places

NOTE: This is not implemented as a Into/From trait to make the loss of precision implicit

pub fn into_biguint_without_scale(self) -> BigUint

pub fn bits(&self) -> usize

pub fn bytes(&self) -> usize

pub fn into_scale<T: FixedScale, R: RoundingMode>(self) -> FixedUnsigned<T>

Convert from scale S to scale T.

Trait Implementations

impl<S> From<BigUint> for FixedUnsigned<S> where
    S: FixedScale, 

fn from(int_value: BigUint) -> Self

Performs the conversion.

impl<S: FixedScale> From<u64> for FixedUnsigned<S>

fn from(x: u64) -> Self

Performs the conversion.

impl<S: FixedScale> From<u32> for FixedUnsigned<S>

fn from(x: u32) -> Self

Performs the conversion.

impl<S: FixedScale> From<u16> for FixedUnsigned<S>

fn from(x: u16) -> Self

Performs the conversion.

impl<S: FixedScale> From<u8> for FixedUnsigned<S>

fn from(x: u8) -> Self

Performs the conversion.

impl<S: FixedScale> From<f64> for FixedUnsigned<S>

Converts a f64 to a FixedUnsigned

fn from(x: f64) -> Self

Performs the conversion.

impl<S: Clone> Clone for FixedUnsigned<S> where
    S: FixedScale, 

fn clone(&self) -> FixedUnsigned<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Default for FixedUnsigned<S> where
    S: FixedScale, 

fn default() -> Self

Returns the "default value" for a type.

impl<S> Eq for FixedUnsigned<S> where
    S: FixedScale, 

impl<S> Ord for FixedUnsigned<S> where
    S: FixedScale, 

fn cmp(&self, other: &Self) -> 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<S> PartialEq<FixedUnsigned<S>> for FixedUnsigned<S> where
    S: FixedScale, 

fn eq(&self, other: &Self) -> 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<S> PartialOrd<FixedUnsigned<S>> for FixedUnsigned<S> where
    S: FixedScale, 

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

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

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

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

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

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

#[must_use] 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<S> Display for FixedUnsigned<S> where
    S: FixedScale, 

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

Formats the value using the given formatter.

impl<S> Debug for FixedUnsigned<S> where
    S: FixedScale, 

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

Formats the value using the given formatter.

impl<S> Div<FixedUnsigned<S>> for FixedUnsigned<S> where
    S: FixedScale, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: FixedUnsigned<S>) -> Self::Output

Performs the / operation.

impl<'a, 'b, S> Div<&'b FixedUnsigned<S>> for &'a FixedUnsigned<S> where
    S: FixedScale, 

type Output = FixedUnsigned<S>

The resulting type after applying the / operator.

fn div(self, rhs: &'b FixedUnsigned<S>) -> FixedUnsigned<S>

Performs the / operation.

impl<S> Sub<FixedUnsigned<S>> for FixedUnsigned<S> where
    S: FixedScale, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: FixedUnsigned<S>) -> Self::Output

Performs the - operation.

impl<'a, 'b, S> Sub<&'b FixedUnsigned<S>> for &'a FixedUnsigned<S> where
    S: FixedScale, 

type Output = FixedUnsigned<S>

The resulting type after applying the - operator.

fn sub(self, rhs: &'b FixedUnsigned<S>) -> FixedUnsigned<S>

Performs the - operation.

impl<S> FromStr for FixedUnsigned<S> where
    S: FixedScale, 

type Err = ParseError

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<S> Add<FixedUnsigned<S>> for FixedUnsigned<S> where
    S: FixedScale, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: FixedUnsigned<S>) -> Self::Output

Performs the + operation.

impl<'a, 'b, S> Add<&'b FixedUnsigned<S>> for &'a FixedUnsigned<S> where
    S: FixedScale, 

type Output = FixedUnsigned<S>

The resulting type after applying the + operator.

fn add(self, rhs: &'b FixedUnsigned<S>) -> FixedUnsigned<S>

Performs the + operation.

impl<S> Mul<FixedUnsigned<S>> for FixedUnsigned<S> where
    S: FixedScale, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: FixedUnsigned<S>) -> Self::Output

Performs the * operation.

impl<'a, 'b, S> Mul<&'b FixedUnsigned<S>> for &'a FixedUnsigned<S> where
    S: FixedScale, 

type Output = FixedUnsigned<S>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b FixedUnsigned<S>) -> FixedUnsigned<S>

Performs the * operation.

impl<S> AddAssign<FixedUnsigned<S>> for FixedUnsigned<S> where
    S: FixedScale, 

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<S> SubAssign<FixedUnsigned<S>> for FixedUnsigned<S> where
    S: FixedScale, 

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<S> MulAssign<FixedUnsigned<S>> for FixedUnsigned<S> where
    S: FixedScale, 

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<S> DivAssign<FixedUnsigned<S>> for FixedUnsigned<S> where
    S: FixedScale, 

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<S> Hash for FixedUnsigned<S> where
    S: FixedScale, 

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<S> One for FixedUnsigned<S> where
    S: FixedScale, 

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl<S> Zero for FixedUnsigned<S> where
    S: FixedScale, 

fn zero() -> Self

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

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

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