Struct sp_arithmetic::Percent

[+] Show declaration

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 + From<u8> + TryInto<u8> + TryInto<u16> + 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<u8> + UniqueSaturatedInto<u8> + 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<u8> + UniqueSaturatedInto<u8> + 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<u8> + UniqueSaturatedInto<u8> + 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<u8> + UniqueSaturatedInto<u8> + 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<u8> + UniqueSaturatedInto<u8> + 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 Percent[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

fn clone(&self) -> Percent[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl CompactAs for Percent[+]

[+] Show hidden undocumented items

type As = u8

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

fn encode_as(&self) -> &u8[−]

Returns the encodable type.

fn decode_from(x: u8) -> Percent[−]

Create Self from the decodable type.

impl Copy for Percent

impl Debug for Percent[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Decode for Percent[+]

[+] Show hidden undocumented items

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

Attempt to deserialise the value from input.

impl Default for Percent[+]

[+] Show hidden undocumented items

fn default() -> Self[−]

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Percent[+]

[+] Show hidden undocumented items

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

impl Div<Percent> for Percent[+]

[+] Show hidden undocumented items

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Encode for Percent[+]

[+] Show hidden undocumented items

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<Percent> for Percent

impl Eq for Percent

impl From<Compact<Percent>> for Percent[+]

[+] Show hidden undocumented items

fn from(x: Compact<Percent>) -> Percent[−]

Performs the conversion.

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

Non-overflow multiplication.

This is tailored to be used with a balance type.

[+] Show hidden undocumented items

type Output = N

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for Percent[+]

[+] Show hidden undocumented items

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

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

#[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<Percent> for Percent[+]

[+] Show hidden undocumented items

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

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

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

This method tests for !=.

impl PartialOrd<Percent> for Percent[+]

[+] Show hidden undocumented items

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

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

fn lt(&self, other: &Percent) -> bool[−]

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

fn le(&self, other: &Percent) -> bool[−]

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

fn gt(&self, other: &Percent) -> bool[−]

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

fn ge(&self, other: &Percent) -> bool[−]

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

impl PerThing for Percent[+]

[+] Show hidden undocumented items

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.

const ACCURACY: Self::Inner[−][−]

The accuracy of this type.

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]

fn from_rational_approximation<N>(p: N, q: N) -> Self where
    N: Clone + Ord + From<Self::Inner> + TryInto<Self::Inner> + TryInto<Self::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.

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.

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 + 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.

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.

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.

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.

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 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[+]

[+] Show hidden undocumented items

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 Percent

impl StructuralPartialEq for Percent