Struct sp_arithmetic::Fixed128

pub struct Fixed128(_);

A signed fixed-point number. Can hold any value in the range [-170_141_183_460_469_231_731, 170_141_183_460_469_231_731] with fixed-point accuracy of 10 ** 18.

Methods

impl Fixed128

pub fn from_natural(int: i128) -> Self

Create self from a natural number.

Note that this might be lossy.

pub const fn accuracy() -> i128

Accuracy of Fixed128.

pub const fn from_parts(parts: i128) -> Self

Raw constructor. Equal to parts / DIV.

pub fn from_rational<N: UniqueSaturatedInto<i128>>(n: N, d: NonZeroI128) -> Self

Creates self from a rational number. Equal to n/d.

Note that this might be lossy. Only use this if you are sure that n * DIV can fit into an i128.

pub fn deconstruct(self) -> i128

Consume self and return the inner raw i128 value.

Note this is a low level function, as the returned value is represented with accuracy.

pub fn recip(&self) -> Option<Self>

Takes the reciprocal(inverse) of Fixed128, 1/x

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

Checked add. Same semantic to num_traits::CheckedAdd.

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

Checked sub. Same semantic to num_traits::CheckedSub.

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

Checked mul. Same semantic to num_traits::CheckedMul.

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

Checked div. Same semantic to num_traits::CheckedDiv.

pub fn checked_mul_int<N>(&self, other: &N) -> Option<N> where
    N: Copy + TryFrom<i128> + TryInto<i128>, 

Checked mul for int type N.

pub fn saturating_mul_int<N>(&self, other: &N) -> N where
    N: Copy + TryFrom<i128> + TryInto<i128> + Bounded, 

Checked mul for int type N.

pub fn checked_div_int<N>(&self, other: &N) -> Option<N> where
    N: Copy + TryFrom<i128> + TryInto<i128>, 

Checked div for int type N.

pub fn zero() -> Self

pub fn is_zero(&self) -> bool

pub fn saturating_abs(&self) -> Self

Saturating absolute value. Returning MAX if parts == i128::MIN instead of overflowing.

pub fn is_positive(&self) -> bool

pub fn is_negative(&self) -> bool

pub fn saturated_multiply_accumulate<N>(self, int: N) -> N where
    N: TryFrom<u128> + From<u64> + UniqueSaturatedInto<u64> + Bounded + Clone + Saturating + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N>, 

Performs a saturated multiply and accumulate by unsigned number.

Returns a saturated int + (self * int).

Trait Implementations

impl Add<Fixed128> for Fixed128

Note that this is a standard, potentially-panicking, implementation. Use Saturating trait for safe addition.

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Bounded for Fixed128

fn min_value() -> Self

returns the smallest finite number this type can represent

fn max_value() -> Self

returns the largest finite number this type can represent

impl Clone for Fixed128

fn clone(&self) -> Fixed128

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Fixed128

impl Debug for Fixed128

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

Formats the value using the given formatter.

impl Decode for Fixed128

fn decode<DecIn: Input>(input: &mut DecIn) -> Result<Self, Error>

Attempt to deserialise the value from input.

impl Default for Fixed128

fn default() -> Fixed128

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Fixed128

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Encode for Fixed128

fn encode_to<EncOut: Output>(&self, dest: &mut EncOut)

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

Convert self to a slice and then invoke the given closure with it.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

impl EncodeLike<Fixed128> for Fixed128

impl Eq for Fixed128

impl<P: PerThing> From<P> for Fixed128

fn from(val: P) -> Self

Performs the conversion.

impl Ord for Fixed128

fn cmp(&self, other: &Fixed128) -> 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<Fixed128> for Fixed128

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

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

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

This method tests for !=.

impl PartialOrd<Fixed128> for Fixed128

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

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

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

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

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

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

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

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

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

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

impl Saturating for Fixed128

fn saturating_add(self, rhs: Self) -> Self

Saturating addition. Compute self + rhs, saturating at the numeric bounds instead of overflowing.

fn saturating_sub(self, rhs: Self) -> Self

Saturating subtraction. Compute self - rhs, saturating at the numeric bounds instead of overflowing.

fn saturating_mul(self, rhs: Self) -> Self

Saturating multiply. Compute self * rhs, saturating at the numeric bounds instead of overflowing.

fn saturating_pow(self, exp: usize) -> Self

Saturating exponentiation. Compute self.pow(exp), saturating at the numeric bounds instead of overflowing.

impl Serialize for Fixed128

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Fixed128

impl StructuralPartialEq for Fixed128

impl Sub<Fixed128> for Fixed128

Note that this is a standard, potentially-panicking, implementation. Use Saturating trait for safe subtraction.

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.