Struct cfg_types::fixed_point::FixedU128

pub struct FixedU128<const DIV: u128>(/* private fields */);

A fixed point number representation in the range. _Fixed Point 128 bits unsigned with variable precision.

Implementations

impl<const DIV: u128> FixedU128<DIV>

pub const fn from_inner(inner: u128) -> Self

const version of FixedPointNumber::from_inner.

pub const fn from_integer(n: u128) -> Self

const version of FixedPointNumber::saturating_from_integer.

Trait Implementations

impl<const DIV: u128> Add for FixedU128<DIV>

type Output = FixedU128<DIV>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const DIV: u128> Bounded for FixedU128<DIV>

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<const DIV: u128> CheckedAdd for FixedU128<DIV>

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

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl<const DIV: u128> CheckedDiv for FixedU128<DIV>

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

Divides two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl<const DIV: u128> CheckedMul for FixedU128<DIV>

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

Multiplies two numbers, checking for underflow or overflow. If underflow or overflow happens, None is returned.

impl<const DIV: u128> CheckedSub for FixedU128<DIV>

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

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl<const DIV: u128> Clone for FixedU128<DIV>

fn clone(&self) -> FixedU128<DIV>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const DIV: u128> CompactAs for FixedU128<DIV>

type As = u128

A compact-encodable type that should be used as the encoding.

fn encode_as(&self) -> &u128

Returns the compact-encodable type.

fn decode_from(x: u128) -> Result<FixedU128<DIV>, Error>

Decode Self from the compact-decoded type.

impl<const DIV: u128> Debug for FixedU128<DIV>

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

Formats the value using the given formatter.

impl<const DIV: u128> Decode for FixedU128<DIV>

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<const DIV: u128> Default for FixedU128<DIV>

fn default() -> FixedU128<DIV>

Returns the “default value” for a type.

impl<'de, const DIV: u128> Deserialize<'de> for FixedU128<DIV>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const DIV: u128> Display for FixedU128<DIV>

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

Formats the value using the given formatter.

impl<const DIV: u128> Div for FixedU128<DIV>

type Output = FixedU128<DIV>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const DIV: u128> Encode for FixedU128<DIV>

fn size_hint(&self) -> usize

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

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

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<__CodecOutputReturn, __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn>( &self, f: __CodecUsingEncodedCallback ) -> __CodecOutputReturn

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<const DIV: u128> FixedPointNumber for FixedU128<DIV>

fn checked_from_rational<N: FixedPointOperand, D: FixedPointOperand>( n: N, d: D ) -> Option<Self>

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

Returns None if d == 0 or n / d exceeds accuracy.

fn checked_mul_int<N: FixedPointOperand>(self, n: N) -> Option<N>

Checked multiplication for integer type N. Equal to self * n.

Returns None if the result does not fit in N.

type Inner = u128

The underlying data type used for this fixed point number.

const DIV: Self::Inner = DIV

Precision of this fixed point implementation. It should be a power of 10.

const SIGNED: bool = false

Indicates if this fixed point implementation is signed or not.

fn from_inner(inner: Self::Inner) -> Self

Builds this type from an integer number.

fn into_inner(self) -> Self::Inner

Consumes self and returns the inner raw value.

fn accuracy() -> Self::Inner

Precision of this fixed point implementation.

fn saturating_from_integer<N>(int: N) -> Self

where N: FixedPointOperand,

Creates self from an integer number int.

fn checked_from_integer<N>(int: N) -> Option<Self>

where N: Into<Self::Inner>,

Creates self from an integer number int.

fn saturating_from_rational<N, D>(n: N, d: D) -> Self

where N: FixedPointOperand, D: FixedPointOperand,

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

fn saturating_mul_int<N>(self, n: N) -> N

where N: FixedPointOperand,

Saturating multiplication for integer type N. Equal to self * n.

fn checked_div_int<N>(self, d: N) -> Option<N>

where N: FixedPointOperand,

Checked division for integer type N. Equal to self / d.

fn saturating_div_int<N>(self, d: N) -> N

where N: FixedPointOperand,

Saturating division for integer type N. Equal to self / d.

fn saturating_mul_acc_int<N>(self, n: N) -> N

where N: FixedPointOperand,

Saturating multiplication for integer type N, adding the result back. Equal to self * n + n.

fn saturating_abs(self) -> Self

Saturating absolute value.

fn reciprocal(self) -> Option<Self>

Takes the reciprocal (inverse). Equal to 1 / self.

fn is_one(&self) -> bool

Checks if the number is one.

fn is_positive(self) -> bool

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

fn is_negative(self) -> bool

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

fn trunc(self) -> Self

Returns the integer part.

fn frac(self) -> Self

Returns the fractional part.

fn ceil(self) -> Self

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

fn floor(self) -> Self

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

fn round(self) -> Self

Returns the number rounded to the nearest integer. Rounds half-way cases away from 0.0.

impl<const DIV: u128> FixedPointNumberExtension for FixedU128<DIV>

fn checked_mul_with_rounding( &self, other: &Self, r: SignedRounding ) -> Option<Self>

Checks multiplication of val with FixedPoint Returns None if out of bounds

fn saturating_mul_with_rounding(self, other: Self, r: SignedRounding) -> Self

multiplies self by param and rounds precision with SignedRounding Saturates if result out of bounds

fn saturating_div_with_rounding(&self, other: &Self, r: SignedRounding) -> Self

divides by param and takes rounding preference for accuracy Saturates result if out of bounds – panics if 0 is denominator

fn checked_div_int_with_rounding<N: FixedPointOperand>( self, int: N, r: SignedRounding ) -> Option<N>

Checked division by FixedPointOperand, with Rounding::SignedRounding rounding preference. Returns None if out of bounds.

Note: This assumes that the FP accuracy has been adjusted to match the accuracy of the FP extended type in question (FixedU128 in this case). For example:

   FixedU128::saturating_from_rational(2)
       .checked_div_with_rounding(2, sp_arithmetic::per_things::SignedRounding::...)

would be equivalent to

     (2 * FixedU128::accuracy) * (FixedU128::accuracy / 2)

instead of

     2 * 1/2.

Whereas

    FixedU128::saturating_from_rational(2)
        .checked_div_with_rounding(2 * FixedU128::accuracy)

would be equivalent to

    2 * FixedU128::accuracy *
       (FixedU128::accuracy / 2 * FixedU128::accuracy)

Which would be 1 * FixedU128::accuracy

fn checked_div_with_rounding( &self, other: &Self, r: SignedRounding ) -> Option<Self>

Checked division by another val of Type Self, with Rounding::SignedRounding rounding preference. Returns None if out of bounds.

fn checked_mul_int_with_rounding<N: FixedPointOperand>( self, int: N, r: SignedRounding ) -> Option<N>

Checked multiplication by FixedPointOperand, with Rounding:SignedRounding rounding preference. Returns None if out of bounds.

fn saturating_mul_int_with_rounding<N: FixedPointOperand>( self, int: N, r: SignedRounding ) -> N

Multiples by FixedPointOperand, with Rounding::SignedRounding rounding preference. Saturates if out of bounds.

fn checked_mul_int_floor<N: FixedPointOperand>(self, int: N) -> Option<N>

Checked multiplication by FixedPointOperand; precision rounded to floor. Returns None if out of bounds.

fn checked_mul_int_ceil<N: FixedPointOperand>(self, int: N) -> Option<N>

Checked multiplication by FixedPointOperand; precision rounded to ceil. Returns None if out of bounds.

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

Checked multiplication by another val of Type Self; rounds precision to floor. Returns None if out of bounds.

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

Checked multiplication by another val of Type Self; rounds precision to ceil. Returns None if out of bounds.

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

Multiples by another val of type Self; rounds precision to floor. Saturates if out of bounds.

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

Multiples by another val of type Self; rounds precision to ceil. Saturates if out of bounds.

fn saturating_mul_int_floor<N: FixedPointOperand>(self, int: N) -> N

Multiplies by FixedPointOperand with Rounding::SignedRounding rounding preference. Saturates if result out of bounds.

fn saturating_mul_int_ceil<N: FixedPointOperand>(self, int: N) -> N

Multiplies by FixedPointOperand; precision rounded to ceil Saturates if result out of bounds.

fn checked_from_rational_with_rounding<N: FixedPointOperand, D: FixedPointOperand>( n: N, d: D, pref: SignedRounding ) -> Option<Self>

Creates Self from rational of FixedPointOperands, with Rounding::SignedRounding rounding preference Returns None if out of bounds

fn checked_from_rational_ceil<N: FixedPointOperand, D: FixedPointOperand>( n: N, d: D ) -> Option<Self>

Creates Self from rational of FixedPointOperands; rounds precision to ceil. Returns None if out of bounds.

fn checked_from_rational_floor<N: FixedPointOperand, D: FixedPointOperand>( n: N, d: D ) -> Option<Self>

Creates Self from rational of FixedPointOperands; rounds precision to floor. Returns None if out of bounds.

fn saturating_from_rational_with_rounding<N: FixedPointOperand, D: FixedPointOperand>( n: N, d: D, r: SignedRounding ) -> Self

Creates Self from rational of FixedPointOperands, with Rounding::SignedRounding rounding preference. Panics if denominator 0 is. Saturates if result out of bounds.

fn saturating_from_rational_floor<N: FixedPointOperand, D: FixedPointOperand>( n: N, d: D ) -> Self

Creates Self from rational of FixedPointOperands; rounds precision to floor. Panics if denominator 0 is. Saturates if result out of bounds.

fn saturating_from_rational_ceil<N: FixedPointOperand, D: FixedPointOperand>( n: N, d: D ) -> Self

Creates Self from rational of FixedPointOperands; rounds precision to ceil. Panics if denominator 0 is. Saturates if result out of bounds.

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

Checked division by another val of Type Self; rounds precision to floor. Returns None if out of bounds.

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

Checked division by another val of Type Self; rounds precision to ceil. Returns None if out of bounds.

fn saturating_div_floor(&self, other: &Self) -> Self

Divides by another val of type Self; rounds precision to floor. Saturates if out of bounds.

fn saturating_div_ceil(&self, other: &Self) -> Self

Divides by another val of type Self; rounds precision to ceil. Saturates if out of bounds.

fn checked_div_int_floor<N: FixedPointOperand>(self, int: N) -> Option<N>

Checked division by FixedPointOperand; rounds precision to floor. Returns None if out of bounds.

fn checked_div_int_ceil<N: FixedPointOperand>(self, int: N) -> Option<N>

Checked division by FixedPointOperand; rounds precision to ceil. Returns None if out of bounds.

fn saturating_div_int_with_rounding<N: FixedPointOperand>( self, int: N, r: SignedRounding ) -> N

Divides by FixedPointOperand, with Rounding:SignedRounding rounding preference. Panics if denominator 0 is. Saturates if result out of bounds.

fn saturating_div_int_floor<N: FixedPointOperand>(self, int: N) -> N

Divides by FixedPointOperand; rounds precision to floor. Panics if denominator 0 is. Saturates if result out of bounds.

fn saturating_div_int_ceil<N: FixedPointOperand>(self, int: N) -> N

Divides by FixedPointOperand; rounds precision to ceil. Panics if denominator 0 is. Saturates if result out of bounds.

fn reciprocal_with_rounding(self, r: SignedRounding) -> Option<Self>

Returns the reciprocal – 1 / self, with Rounding:SignedRounding rounding preference. Returns None if self is 0

fn reciprocal_floor(self) -> Option<Self>

Returns reciprocal; rounds precision to floor. Returns None if self is 0

fn reciprocal_ceil(self) -> Option<Self>

Returns reciprocal; rounds precision to ceil. Returns None if self is 0

fn saturating_pow_with_rounding(self, pow: usize, r: SignedRounding) -> Self

Checked self raised to pow. Saturate if result out of bounds.

fn saturating_pow_floor(self, pow: usize) -> Self

Checked self raised to pow; rounds precision to floor. Saturates if result out of bounds.

fn saturating_pow_ceil(self, pow: usize) -> Self

Checked self raised to pow; rounds precision to ceil. Saturates if result out of bounds.

impl<N: FixedPointOperand, D: FixedPointOperand, const DIV: u128> From<(N, D)> for FixedU128<DIV>

fn from(r: (N, D)) -> Self

Converts to this type from the input type.

impl<const DIV: u128> From<Compact<FixedU128<DIV>>> for FixedU128<DIV>

fn from(x: Compact<FixedU128<DIV>>) -> FixedU128<DIV>

Converts to this type from the input type.

impl<const DIV: u128> From<u128> for FixedU128<DIV>

fn from(int: u128) -> Self

Converts to this type from the input type.

impl<const DIV: u128> FromStr for FixedU128<DIV>

type Err = &'static str

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<const DIV: u128> MaxEncodedLen for FixedU128<DIV>

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<const DIV: u128> Mul for FixedU128<DIV>

type Output = FixedU128<DIV>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const DIV: u128> Neg for FixedU128<DIV>

type Output = FixedU128<DIV>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const DIV: u128> One for FixedU128<DIV>

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,

Returns true if self is equal to the multiplicative identity.

impl<const DIV: u128> Ord for FixedU128<DIV>

fn cmp(&self, other: &FixedU128<DIV>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<const DIV: u128> PartialEq for FixedU128<DIV>

fn eq(&self, other: &FixedU128<DIV>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const DIV: u128> PartialOrd for FixedU128<DIV>

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

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

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

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

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

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

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

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

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<const DIV: u128> Saturating for FixedU128<DIV>

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.

fn saturating_less_one(self) -> Self

where Self: One,

Decrement self by one, saturating at zero.

fn saturating_plus_one(self) -> Self

where Self: One,

Increment self by one, saturating at the numeric bounds instead of overflowing.

fn saturating_inc(&mut self)

where Self: One,

Increment self by one, saturating.

fn saturating_dec(&mut self)

where Self: One,

Decrement self by one, saturating at zero.

fn saturating_accrue(&mut self, amount: Self)

where Self: One,

Increment self by some amount, saturating.

fn saturating_reduce(&mut self, amount: Self)

where Self: One,

Decrement self by some amount, saturating at zero.

impl<const DIV: u128> Serialize for FixedU128<DIV>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<const DIV: u128> Sub for FixedU128<DIV>

type Output = FixedU128<DIV>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const DIV: u128> TypeInfo for FixedU128<DIV>

type Identity = FixedU128<DIV>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<const DIV: u128> Zero for FixedU128<DIV>

fn zero() -> Self

Returns the additive identity element of Self, 0.

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.

impl<const DIV: u128> Copy for FixedU128<DIV>

impl<const DIV: u128> EncodeLike for FixedU128<DIV>

impl<const DIV: u128> Eq for FixedU128<DIV>

impl<const DIV: u128> StructuralPartialEq for FixedU128<DIV>