Struct sp_arithmetic::per_things::Percent

source · [−]

pub struct Percent(_);

Expand description

A fixed point representation of a number in the range [0, 1].

Percent

Implementations

impl Percent

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

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

pub const fn from_percent(x: u8) -> Self

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

This can be created at compile time.

pub const fn one() -> Self

See PerThing::one

pub fn is_one(&self) -> bool

See PerThing::is_one.

pub const fn zero() -> Self

See PerThing::zero.

pub fn is_zero(&self) -> bool

See PerThing::is_zero.

pub const fn deconstruct(self) -> u8

See PerThing::deconstruct.

pub fn square(self) -> Self

See PerThing::square.

pub fn from_fraction(x: f64) -> Self

See PerThing::from_fraction.

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

See PerThing::from_rational_approximation.

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

See PerThing::mul_floor.

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

See PerThing::mul_ceil.

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

See PerThing::saturating_reciprocal_mul.

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

See PerThing::saturating_reciprocal_mul_floor.

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

See PerThing::saturating_reciprocal_mul_ceil.

Trait Implementations

impl Bounded for Percent

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 Percent

fn clone(&self) -> Percent

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl CompactAs for Percent

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

type As = u8

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

fn encode_as(&self) -> &Self::As

Returns the compact-encodable type.

fn decode_from(x: Self::As) -> Result<Self, Error>

Decode Self from the compact-decoded type.

impl Debug for Percent

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

Formats the value using the given formatter. Read more

impl Decode for Percent

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

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input. Read more

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type. Read more

impl Default for Percent

fn default() -> Self

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Percent

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

Deserialize this value from the given Serde deserializer. Read more

impl Div<Percent> for Percent

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl Encode for Percent

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<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. Read more

fn encoded_size(&self) -> usize

Calculates the encoded size. Read more

impl From<Compact<Percent>> for Percent

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

Performs the conversion.

impl<N> Mul<N> for Percent where
N: Clone + UniqueSaturatedInto<u8> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Unsigned,
u8: Into<N>,

Non-overflow multiplication.

This is tailored to be used with a balance type.

type Output = N

The resulting type after applying the * operator.

fn mul(self, b: N) -> Self::Output

Performs the * operation. Read more

impl Ord for Percent

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

impl PartialEq<Percent> for Percent

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

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

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

This method tests for !=.

impl PartialOrd<Percent> for Percent

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

impl PerThing for Percent

fn deconstruct(self) -> Self::Inner

Consume self and return the number of parts per thing.

fn from_parts(parts: Self::Inner) -> Self

Build this type from a number of parts per thing.

fn from_fraction(x: f64) -> Self

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

type Inner = u8

The data type used to build this per-thingy.

type Upper = u16

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

const ACCURACY: Self::Inner

The accuracy of this type.

fn from_rational_approximation<N>(p: N, q: N) -> Self where
N: Clone + Ord + TryInto<Self::Inner> + TryInto<Self::Upper> + Div<N, Output = N> + Rem<N, Output = N> + Add<N, Output = N> + Unsigned + Zero + One,
Self::Inner: Into<N>,

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

fn zero() -> Self

Equivalent to Self::from_parts(0).

fn is_zero(&self) -> bool

Return true if this is nothing.

fn one() -> Self

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

fn is_one(&self) -> bool

Return true if this is one.

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 and can cope with potential type overflows. Read more

fn square(self) -> Self

Return the product of multiplication of this value by itself.

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

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

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

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

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

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. Read more

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

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. Read more

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

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. Read more

impl Saturating for Percent

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

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

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

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

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

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

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

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

impl Serialize for Percent

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

Serialize this value into the given Serde serializer. Read more

impl Copy for Percent

impl EncodeLike<Percent> for Percent

impl Eq for Percent

impl StructuralEq for Percent

impl StructuralPartialEq for Percent

Auto Trait Implementations

impl RefUnwindSafe for Percent

impl Send for Percent

impl Sync for Percent

impl Unpin for Percent

impl UnwindSafe for Percent

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> DecodeAll for T where
T: Decode,

pub fn decode_all(input: &[u8 ]) -> Result<T, Error>

Decode Self and consume all of the given input data. Read more

impl<T> DecodeLimit for T where
T: Decode,

pub fn decode_all_with_depth_limit(limit: u32, input: &[u8 ]) -> Result<T, Error>

Decode Self and consume all of the given input data. Read more

pub fn decode_with_depth_limit(limit: u32, input: &[u8 ]) -> Result<T, Error>

Decode Self with the given maximum recursion depth. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T> HasCompact for T where
    T: 'static,
    Compact<T>: for<'a> EncodeAsRef<'a, T>,
    Compact<T>: Decode,
    Compact<T>: From<T>,
    Compact<T>: Into<T>,

type Type = Compact<T>

The compact type; this can be

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> KeyedVec for T where
T: Codec,

pub fn to_keyed_vec(&self, prepend_key: &[u8 ]) -> Vec<u8, Global>

Return an encoding of Self prepended by given slice.

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T, S> UniqueSaturatedFrom<T> for S where
S: TryFrom<T> + Bounded,

fn unique_saturated_from(t: T) -> Self

Convert from a value of T into an equivalent instance of Self.

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

impl<S> Codec for S where
S: Decode + Encode,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

impl<'_, '_, T> EncodeLike<&'_ &'_ T> for T where
T: Encode,

impl<'_, T> EncodeLike<&'_ T> for T where
T: Encode,

impl<'_, T> EncodeLike<&'_ mut T> for T where
T: Encode,

impl<T> EncodeLike<Arc<T>> for T where
T: Encode,

impl<T> EncodeLike<Box<T, Global>> for T where
T: Encode,

impl<'a, T> EncodeLike<Cow<'a, T>> for T where
T: ToOwned + Encode,

impl<T> EncodeLike<Rc<T>> for T where
T: Encode,

impl<S> FullCodec for S where
S: Decode + FullEncode,

impl<S> FullEncode for S where
S: Encode + EncodeLike<S>,