Struct sp_arithmetic::per_things::PerU16

impl PerU16

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

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

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

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

This can be created at compile time.

pub fn from_rational_approximation<N>(p: N, q: N) -> Self
where N: RationalArg + TryInto<u16> + TryInto<u32>, u16: Into<N>,

👎Deprecated: Use PerThing::from_rational instead

See PerThing::from_rational.

pub fn from_rational<N>(p: N, q: N) -> Self
where N: RationalArg + TryInto<u16> + TryInto<u32>, u16: Into<N>,

See PerThing::from_rational.

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

Integer multiplication with another value, saturating at 1.

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

Integer division with another value, rounding down.

pub fn mul_floor<N>(self, b: N) -> N
where N: MultiplyArg + UniqueSaturatedInto<u16>, u16: Into<N>,

See PerThing::mul_floor.

pub fn mul_ceil<N>(self, b: N) -> N
where N: MultiplyArg + UniqueSaturatedInto<u16>, u16: Into<N>,

See PerThing::mul_ceil.

pub fn saturating_reciprocal_mul<N>(self, b: N) -> N
where N: ReciprocalArg + UniqueSaturatedInto<u16>, u16: Into<N>,

See PerThing::saturating_reciprocal_mul.

pub fn saturating_reciprocal_mul_floor<N>(self, b: N) -> N
where N: ReciprocalArg + UniqueSaturatedInto<u16>, u16: Into<N>,

See PerThing::saturating_reciprocal_mul_floor.

pub fn saturating_reciprocal_mul_ceil<N>(self, b: N) -> N
where N: ReciprocalArg + UniqueSaturatedInto<u16>, u16: 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),
);

impl PerU16

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

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

This can be created at compile time.

Trait Implementations§

impl Add for PerU16

type Output = PerU16

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl Bounded for PerU16

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 PerU16

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

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

impl CheckedMul for PerU16

§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 PerU16

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

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

impl Clone for PerU16

fn clone(&self) -> PerU16

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

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 PerU16

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

Formats the value using the given formatter. Read more

impl Decode for PerU16

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

Attempt to deserialise the value from input.

fn decode_into( 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. Read more

fn skip(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 PerU16

fn default() -> Self

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

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

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

Deserialize this value from the given Serde deserializer. Read more

impl<N> Div<N> for PerU16
where u16: TryFrom<N>,

type Output = PerU16

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl Div for PerU16

type Output = PerU16

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl Encode for PerU16

fn size_hint(&self) -> usize

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

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<CodecOutputReturn, CodecUsingEncodedCallback: FnOnce(&[u8]) -> CodecOutputReturn>( &self, f: CodecUsingEncodedCallback ) -> __CodecOutputReturn

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

fn encoded_size(&self) -> usize

Calculates the encoded size. Read more

impl From<Compact<PerU16>> for PerU16

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

Converts to this type from the input type.

impl MaxEncodedLen for PerU16

fn max_encoded_len() -> usize

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

impl<N> Mul<N> for PerU16
where N: Clone + UniqueSaturatedInto<u16> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Unsigned, u16: 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 Mul for PerU16

type Output = PerU16

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl One for PerU16

fn one() -> Self

Returns the multiplicative identity element of Self, 1. Read more

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

impl Ord for PerU16

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

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

1.21.0 · source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · source§

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

Restrict a value to a certain interval. Read more

impl PartialEq for PerU16

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

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

1.0.0 · source§

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 PerU16

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

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

const ACCURACY: Self::Inner = {transmute(0xffff): <per_things::PerU16 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 + MultiplyRational, Self::Inner: Into<N>,

Approximate the fraction p/q into a per-thing fraction. 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 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) -> N
where N: MultiplyArg + UniqueSaturatedInto<Self::Inner>, 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: MultiplyArg + UniqueSaturatedInto<Self::Inner>, 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: ReciprocalArg + UniqueSaturatedInto<Self::Inner>, 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: ReciprocalArg + UniqueSaturatedInto<Self::Inner>, 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: ReciprocalArg + UniqueSaturatedInto<Self::Inner>, 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

fn from_fraction(x: f64) -> Self

👎Deprecated: Use from_float instead

Same as Self::from_float.

fn from_rational<N>(p: N, q: N) -> Self
where N: RationalArg + TryInto<Self::Inner> + TryInto<Self::Upper>, Self::Inner: Into<N>,

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

fn from_rational_approximation<N>(p: N, q: N) -> Self
where N: RationalArg + TryInto<Self::Inner> + TryInto<Self::Upper>, Self::Inner: Into<N>,

👎Deprecated: Use from_rational instead

Same as Self::from_rational.

impl Pow<usize> for PerU16

type Output = PerU16

The result after applying the operator.

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

Returns self to the power rhs. Read more

impl Saturating for PerU16

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.