Struct sp_arithmetic::per_things::Percent

pub struct Percent(_);

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_float(x: f64) -> Self

See PerThing::from_float.

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

👎Deprecated: Use PerThing::from_rational instead

See PerThing::from_rational.

pub fn from_rational<N>(p: N, q: N) -> Selfwhere
    N: Clone + Ord + TryInto<u8> + TryInto<u16> + Div<N, Output = N> + Rem<N, Output = N> + Add<N, Output = N> + AddAssign<N> + Unsigned + Zero + One,
    u8: Into<N>,

See PerThing::from_rational.

pub fn int_mul(self, b: u8) -> Self

Integer multiplication with another value, saturating at 1.

pub fn int_div(self, b: Self) -> u8

Integer division with another value, rounding down.

pub fn mul_floor<N>(self, b: N) -> Nwhere
    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) -> Nwhere
    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) -> Nwhere
    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) -> Nwhere
    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) -> Nwhere
    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.

pub fn saturating_div(self, rhs: Self, r: Rounding) -> Self

Saturating division. Compute self / rhs, saturating at one if rhs < self.

The rounding method must be specified. e.g.:

let pc = |x| Percent::from_percent(x);
assert_eq!(
	pc(2).saturating_div(pc(3), Down),
	pc(66),
);
assert_eq!(
	pc(1).saturating_div(pc(3), NearestPrefUp),
	pc(33),
);
assert_eq!(
	pc(2).saturating_div(pc(3), NearestPrefDown),
	pc(67),
);
assert_eq!(
	pc(1).saturating_div(pc(3), Up),
	pc(34),
);

Trait Implementations

impl Add<Percent> for Percent

type Output = Percent

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

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

impl CheckedMul for Percent

Note

CheckedMul will never fail for PerThings.

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

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

impl CheckedSub for Percent

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

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

impl Clone for Percent

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

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.

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.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for Percent

fn default() -> Self

Returns the “default value” for a type.

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.

impl<N> Div<N> for Percentwhere
    u8: TryFrom<N>,

type Output = Percent

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Percent> for Percent

type Output = Percent

The resulting type after applying the / operator.

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

Performs the / operation.

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.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<Compact<Percent>> for Percent

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

Converts to this type from the input type.

impl MaxEncodedLen for Percent

fn max_encoded_len() -> usize

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

impl<N> Mul<N> for Percentwhere
    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.

impl Mul<Percent> for Percent

type Output = Percent

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for Percent

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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

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

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: &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 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_float(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.

const ACCURACY: Self::Inner = {transmute(0x64): <per_things::Percent as per_things::PerThing>::Inner}

The accuracy of this type.

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

Approximate the fraction p/q into a per-thing fraction.

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 less_epsilon(self) -> Self

Return the next lower value to self or self if it is already zero.

fn try_less_epsilon(self) -> Result<Self, Self>

Return the next lower value to self or an error with the same value if self is already zero.

fn plus_epsilon(self) -> Self

Return the next higher value to self or self if it is already one.

fn try_plus_epsilon(self) -> Result<Self, Self>

Return the next higher value to self or an error with the same value if self is already 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.

fn square(self) -> Self

Return the product of multiplication of this value by itself.

fn left_from_one(self) -> Self

Return the part left when self is saturating-subtracted from Self::one().

fn mul_floor<N>(self, b: N) -> Nwhere
    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.

fn mul_ceil<N>(self, b: N) -> Nwhere
    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.

fn saturating_reciprocal_mul<N>(self, b: N) -> Nwhere
    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.

fn saturating_reciprocal_mul_floor<N>(self, b: N) -> Nwhere
    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.

fn saturating_reciprocal_mul_ceil<N>(self, b: N) -> Nwhere
    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.

fn from_fraction(x: f64) -> Self

👎Deprecated: Use from_float instead

Same as Self::from_float.

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

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

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

👎Deprecated: Use from_rational instead

Same as Self::from_rational.

impl Pow<usize> for Percent

type Output = Percent

The result after applying the operator.

fn pow(self, exp: usize) -> Self::Output

Returns self to the power rhs.

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

fn saturating_add(&self, v: &Self) -> Self

Saturating addition. Computes self + other, saturating at the relevant high or low boundary of the type.

impl SaturatingSub for Percent

fn saturating_sub(&self, v: &Self) -> Self

Saturating subtraction. Computes self - other, saturating at the relevant high or low boundary of the type.

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.

impl Sub<Percent> for Percent

type Output = Percent

The resulting type after applying the - operator.

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

Performs the - operation.

impl TypeInfo for Percent

type Identity = Percent

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Zero for Percent

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

impl EncodeLike<Percent> for Percent

impl Eq for Percent

impl StructuralEq for Percent

impl StructuralPartialEq for Percent