Struct polkadot_sdk_frame::arithmetic::FixedI128

pub struct FixedI128(/* private fields */);

A fixed point number representation in the range. Fixed Point 128 bits signed, range = [-170141183460469231731.687303715884105728, 170141183460469231731.687303715884105727]

Implementations

impl FixedI128

pub const fn from_inner(inner: i128) -> FixedI128

Create a new instance from the given inner value.

const version of FixedPointNumber::from_inner.

pub const fn into_inner(self) -> i128

Return the instance’s inner value.

const version of FixedPointNumber::into_inner.

pub const fn from_u32(n: u32) -> FixedI128

Creates self from a u32.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub fn from_float(x: f64) -> FixedI128

Convert from a float value.

pub const fn from_perbill(n: Perbill) -> FixedI128

Convert from a Perbill value.

pub const fn into_perbill(self) -> Perbill

Convert into a Perbill value. Will saturate if above one or below zero.

pub fn to_float(self) -> f64

Convert into a float value.

pub fn try_into_perthing<P>(self) -> Result<P, P>

where P: PerThing,

Attempt to convert into a PerThing. This will succeed iff self is at least zero and at most one. If it is out of bounds, it will result in an error returning the clamped value.

pub fn into_clamped_perthing<P>(self) -> P

where P: PerThing,

Attempt to convert into a PerThing. This will always succeed resulting in a clamped value if self is less than zero or greater than one.

pub const fn neg(self) -> FixedI128

Negate the value.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub const fn sqrt(self) -> FixedI128

Take the square root of a positive value.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub const fn try_sqrt(self) -> Option<FixedI128>

Compute the square root, rounding as desired. If it overflows or is negative, then None is returned.

pub const fn add(self, rhs: FixedI128) -> FixedI128

Add a value and return the result.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub const fn sub(self, rhs: FixedI128) -> FixedI128

Subtract a value and return the result.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub const fn mul(self, rhs: FixedI128) -> FixedI128

Multiply by a value and return the result.

Result will be rounded to the nearest representable value, rounding down if it is equidistant between two neighbours.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub const fn div(self, rhs: FixedI128) -> FixedI128

Divide by a value and return the result.

Result will be rounded to the nearest representable value, rounding down if it is equidistant between two neighbours.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub const fn from_rational(a: u128, b: u128) -> FixedI128

Calculate an approximation of a rational.

Result will be rounded to the nearest representable value, rounding down if it is equidistant between two neighbours.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub const fn from_rational_with_rounding( a: u128, b: u128, rounding: Rounding, ) -> FixedI128

Calculate an approximation of a rational with custom rounding.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub const fn const_checked_mul(self, other: FixedI128) -> Option<FixedI128>

Multiply by another value, returning None in the case of an error.

Result will be rounded to the nearest representable value, rounding down if it is equidistant between two neighbours.

pub const fn const_checked_mul_with_rounding( self, other: FixedI128, rounding: SignedRounding, ) -> Option<FixedI128>

Multiply by another value with custom rounding, returning None in the case of an error.

Result will be rounded to the nearest representable value, rounding down if it is equidistant between two neighbours.

pub const fn const_checked_div(self, other: FixedI128) -> Option<FixedI128>

Divide by another value, returning None in the case of an error.

Result will be rounded to the nearest representable value, rounding down if it is equidistant between two neighbours.

pub const fn checked_rounding_div( self, other: FixedI128, rounding: SignedRounding, ) -> Option<FixedI128>

Divide by another value with custom rounding, returning None in the case of an error.

Result will be rounded to the nearest representable value, rounding down if it is equidistant between two neighbours.

Trait Implementations

impl Add for FixedI128

type Output = FixedI128

The resulting type after applying the + operator.

fn add(self, rhs: FixedI128) -> <FixedI128 as Add>::Output

Performs the + operation.

impl Bounded for FixedI128

fn min_value() -> FixedI128

Returns the smallest finite number this type can represent

fn max_value() -> FixedI128

Returns the largest finite number this type can represent

impl CheckedAdd for FixedI128

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

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

impl CheckedDiv for FixedI128

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

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

impl CheckedMul for FixedI128

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

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

impl CheckedSub for FixedI128

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

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

impl Clone for FixedI128

fn clone(&self) -> FixedI128

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompactAs for FixedI128

type As = i128

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

fn encode_as(&self) -> &i128

Returns the compact-encodable type.

fn decode_from(x: i128) -> Result<FixedI128, Error>

Decode Self from the compact-decoded type.

impl Debug for FixedI128

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

Formats the value using the given formatter.

impl Decode for FixedI128

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

where __CodecInputEdqy: Input,

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 Default for FixedI128

fn default() -> FixedI128

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FixedI128

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FixedI128

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

Formats the value using the given formatter.

impl Div for FixedI128

type Output = FixedI128

The resulting type after applying the / operator.

fn div(self, rhs: FixedI128) -> <FixedI128 as Div>::Output

Performs the / operation.

impl Encode for FixedI128

fn size_hint(&self) -> usize

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

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

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

where __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn,

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl FixedPointNumber for FixedI128

type Inner = i128

The underlying data type used for this fixed point number.

const DIV: <FixedI128 as FixedPointNumber>::Inner = {transmute(0x00000000000000000de0b6b3a7640000): <sp_runtime::FixedI128 as sp_runtime::FixedPointNumber>::Inner}

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

const SIGNED: bool = true

Indicates if this fixed point implementation is signed or not.

fn from_inner(inner: <FixedI128 as FixedPointNumber>::Inner) -> FixedI128

Builds this type from an integer number.

fn into_inner(self) -> <FixedI128 as FixedPointNumber>::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 checked_from_rational<N, D>(n: N, d: D) -> Option<Self>

where N: FixedPointOperand, D: FixedPointOperand,

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

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

where N: FixedPointOperand,

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

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<N, D> From<(N, D)> for FixedI128

where N: FixedPointOperand, D: FixedPointOperand,

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

Converts to this type from the input type.

impl From<Compact<FixedI128>> for FixedI128

fn from(x: Compact<FixedI128>) -> FixedI128

Converts to this type from the input type.

impl<P> From<P> for FixedI128

where P: PerThing, <P as PerThing>::Inner: FixedPointOperand,

fn from(p: P) -> FixedI128

Converts to this type from the input type.

impl From<i128> for FixedI128

fn from(int: i128) -> FixedI128

Converts to this type from the input type.

impl FromStr for FixedI128

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<FixedI128, <FixedI128 as FromStr>::Err>

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

impl MaxEncodedLen for FixedI128

fn max_encoded_len() -> usize

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

impl Mul for FixedI128

type Output = FixedI128

The resulting type after applying the * operator.

fn mul(self, rhs: FixedI128) -> <FixedI128 as Mul>::Output

Performs the * operation.

impl Neg for FixedI128

type Output = FixedI128

The resulting type after applying the - operator.

fn neg(self) -> <FixedI128 as Neg>::Output

Performs the unary - operation.

impl One for FixedI128

fn one() -> FixedI128

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 Ord for FixedI128

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

fn eq(&self, other: &FixedI128) -> 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 PartialOrd for FixedI128

fn partial_cmp(&self, other: &FixedI128) -> 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 Saturating for FixedI128

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

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

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

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

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

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

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

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 Serialize for FixedI128

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for FixedI128

type Output = FixedI128

The resulting type after applying the - operator.

fn sub(self, rhs: FixedI128) -> <FixedI128 as Sub>::Output

Performs the - operation.

impl TypeInfo for FixedI128

type Identity = FixedI128

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Zero for FixedI128

fn zero() -> FixedI128

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 Copy for FixedI128

impl EncodeLike for FixedI128

impl Eq for FixedI128

impl StructuralPartialEq for FixedI128