Struct sp_runtime::PerU16

pub struct PerU16(_);

Re-export top-level arithmetic stuff. A fixed point representation of a number in the range [0, 1].

Parts per 65535

Implementations

impl PerU16

Re-export top-level arithmetic stuff.

pub const fn from_perthousand(x: u16) -> PerU16

Converts a percent into Self. Equal to x / 1000.

This can be created at compile time.

impl PerU16

Re-export top-level arithmetic stuff.

pub const fn from_parts(parts: u16) -> PerU16

From an explicitly defined number of parts per maximum of the type.

pub const fn from_percent(x: u16) -> PerU16

Converts a percent into Self. Equal to x / 100.

This can be created at compile time.

pub const fn one() -> PerU16

See PerThing::one

pub fn is_one(&self) -> bool

See PerThing::is_one.

pub const fn zero() -> PerU16

See PerThing::zero.

pub fn is_zero(&self) -> bool

See PerThing::is_zero.

pub const fn deconstruct(self) -> u16

See PerThing::deconstruct.

pub fn square(self) -> PerU16

See PerThing::square.

pub fn from_fraction(x: f64) -> PerU16

See PerThing::from_fraction.

pub fn from_rational_approximation<N>(p: N, q: N) -> PerU16 where
    N: Clone + Ord + From<u16> + TryInto<u16> + TryInto<u32> + Div<N, Output = N> + Rem<N, Output = N> + Add<N, Output = N> + Unsigned, 

See PerThing::from_rational_approximation.

pub fn mul_floor<N>(self, b: N) -> N where
    N: Clone + From<u16> + UniqueSaturatedInto<u16> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Unsigned, 

See PerThing::mul_floor.

pub fn mul_ceil<N>(self, b: N) -> N where
    N: Clone + From<u16> + UniqueSaturatedInto<u16> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Unsigned, 

See PerThing::mul_ceil.

pub fn saturating_reciprocal_mul<N>(self, b: N) -> N where
    N: Clone + From<u16> + UniqueSaturatedInto<u16> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Saturating + Unsigned, 

See PerThing::saturating_reciprocal_mul.

pub fn saturating_reciprocal_mul_floor<N>(self, b: N) -> N where
    N: Clone + From<u16> + UniqueSaturatedInto<u16> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Saturating + Unsigned, 

See PerThing::saturating_reciprocal_mul_floor.

pub fn saturating_reciprocal_mul_ceil<N>(self, b: N) -> N where
    N: Clone + From<u16> + UniqueSaturatedInto<u16> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Saturating + Unsigned, 

See PerThing::saturating_reciprocal_mul_ceil.

Trait Implementations

impl Bounded for PerU16

pub fn min_value() -> PerU16

returns the smallest finite number this type can represent

pub fn max_value() -> PerU16

returns the largest finite number this type can represent

impl Clone for PerU16

pub fn clone(&self) -> PerU16

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompactAs for PerU16

Implementation makes any compact encoding of PerThing::Inner valid, when decoding it will saturate up to PerThing::ACCURACY.

type As = u16

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

pub fn encode_as(&self) -> &<PerU16 as CompactAs>::As

Returns the encodable type.

pub fn decode_from(x: <PerU16 as CompactAs>::As) -> PerU16

Create Self from the decodable type.

impl Copy for PerU16

impl Debug for PerU16

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

Formats the value using the given formatter.

impl Decode for PerU16

pub fn decode<I>(input: &mut I) -> Result<PerU16, Error> where
    I: Input, 

Attempt to deserialise the value from input.

impl Default for PerU16

pub fn default() -> PerU16

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for PerU16

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<PerU16, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Div<PerU16> for PerU16

type Output = PerU16

The resulting type after applying the / operator.

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

Performs the / operation.

impl Encode for PerU16

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

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

pub fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

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

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

pub fn size_hint(&self) -> usize

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

impl EncodeLike<PerU16> for PerU16

impl Eq for PerU16

impl From<Compact<PerU16>> for PerU16

pub fn from(x: Compact<PerU16>) -> PerU16

Performs the conversion.

impl<N> Mul<N> for PerU16 where
    N: Rem<N, Output = N> + Div<N, Output = N> + Clone + Mul<N, Output = N> + From<u16> + Add<N, Output = N> + UniqueSaturatedInto<u16> + Unsigned, 

Non-overflow multiplication.

This is tailored to be used with a balance type.

type Output = N

The resulting type after applying the * operator.

pub fn mul(self, b: N) -> <PerU16 as Mul<N>>::Output

Performs the * operation.

impl Ord for PerU16

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PerU16> for PerU16

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

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

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

This method tests for !=.

impl PartialOrd<PerU16> for PerU16

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

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

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

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

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

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

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

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

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

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

impl PerThing for PerU16

type Inner = u16

The data type used to build this per-thingy.

type Upper = u32

A data type larger than Self::Inner, used to avoid overflow in some computations. It must be able to compute ACCURACY^2.

pub const ACCURACY: <PerU16 as PerThing>::Inner

The accuracy of this type.

pub fn deconstruct(self) -> <PerU16 as PerThing>::Inner

Consume self and return the number of parts per thing.

pub fn from_parts(parts: <PerU16 as PerThing>::Inner) -> PerU16

Build this type from a number of parts per thing.

pub fn from_fraction(x: f64) -> PerU16

NOTE: saturate to 0 or 1 if x is beyond [0, 1]

pub fn from_rational_approximation<N>(p: N, q: N) -> PerU16 where
    N: Clone + Ord + From<<PerU16 as PerThing>::Inner> + TryInto<<PerU16 as PerThing>::Inner> + TryInto<<PerU16 as PerThing>::Upper> + Div<N, Output = N> + Rem<N, Output = N> + Add<N, Output = N> + Unsigned, 

Approximate the fraction p/q into a per-thing fraction. This will never overflow.

pub fn zero() -> Self

Equivalent to Self::from_parts(0).

pub fn is_zero(&self) -> bool

Return true if this is nothing.

pub fn one() -> Self

Equivalent to Self::from_parts(Self::ACCURACY).

pub fn is_one(&self) -> bool

Return true if this is one.

pub fn from_percent(x: Self::Inner) -> Self

Build this type from a percent. Equivalent to Self::from_parts(x * Self::ACCURACY / 100) but more accurate.

pub fn square(self) -> Self

Return the product of multiplication of this value by itself.

pub fn mul_floor<N>(self, b: N) -> N where
    N: Clone + From<Self::Inner> + UniqueSaturatedInto<Self::Inner> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Unsigned, 

Multiplication that always rounds down to a whole number. The standard Mul rounds to the nearest whole number.

pub fn mul_ceil<N>(self, b: N) -> N where
    N: Clone + From<Self::Inner> + UniqueSaturatedInto<Self::Inner> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Unsigned, 

Multiplication that always rounds the result up to a whole number. The standard Mul rounds to the nearest whole number.

pub fn saturating_reciprocal_mul<N>(self, b: N) -> N where
    N: Clone + From<Self::Inner> + UniqueSaturatedInto<Self::Inner> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Saturating + Unsigned, 

Saturating multiplication by the reciprocal of self. The result is rounded to the nearest whole number and saturates at the numeric bounds instead of overflowing.

pub fn saturating_reciprocal_mul_floor<N>(self, b: N) -> N where
    N: Clone + From<Self::Inner> + UniqueSaturatedInto<Self::Inner> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Saturating + Unsigned, 

Saturating multiplication by the reciprocal of self. The result is rounded down to the nearest whole number and saturates at the numeric bounds instead of overflowing.

pub fn saturating_reciprocal_mul_ceil<N>(self, b: N) -> N where
    N: Clone + From<Self::Inner> + UniqueSaturatedInto<Self::Inner> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Saturating + Unsigned, 

Saturating multiplication by the reciprocal of self. The result is rounded up to the nearest whole number and saturates at the numeric bounds instead of overflowing.

impl Saturating for PerU16

pub fn saturating_add(self, rhs: PerU16) -> PerU16

Saturating addition. Compute self + rhs, saturating at the numeric bounds instead of overflowing. This operation is lossless if it does not saturate.

pub fn saturating_sub(self, rhs: PerU16) -> PerU16

Saturating subtraction. Compute self - rhs, saturating at the numeric bounds instead of overflowing. This operation is lossless if it does not saturate.

pub fn saturating_mul(self, rhs: PerU16) -> PerU16

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

pub fn saturating_pow(self, exp: usize) -> PerU16

Saturating exponentiation. Computes self.pow(exp), saturating at the numeric bounds instead of overflowing. This operation is lossy.

impl Serialize for PerU16

pub 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 StructuralEq for PerU16

impl StructuralPartialEq for PerU16