Struct sp_arithmetic::PerU16[][src]

pub struct PerU16(_);

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

Parts per 65535

Implementations

impl PerU16[src]

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

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

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

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

This can be created at compile time.

pub const fn one() -> Self[src]

pub fn is_one(&self) -> bool[src]

pub const fn zero() -> Self[src]

pub fn is_zero(&self) -> bool[src]

pub const fn deconstruct(self) -> u16[src]

pub fn square(self) -> Self[src]

pub fn from_fraction(x: f64) -> Self[src]

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

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

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

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

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

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

impl PerU16[src]

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

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

This can be created at compile time.

Trait Implementations

impl Bounded for PerU16[src]

impl Clone for PerU16[src]

impl CompactAs for PerU16[src]

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.

impl Copy for PerU16[src]

impl Debug for PerU16[src]

impl Decode for PerU16[src]

impl Default for PerU16[src]

impl<'de> Deserialize<'de> for PerU16[src]

impl Div<PerU16> for PerU16[src]

type Output = Self

The resulting type after applying the / operator.

impl Encode for PerU16[src]

impl EncodeLike<PerU16> for PerU16[src]

impl Eq for PerU16[src]

impl From<Compact<PerU16>> for PerU16[src]

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

Non-overflow multiplication.

This is tailored to be used with a balance type.

type Output = N

The resulting type after applying the * operator.

impl Ord for PerU16[src]

impl PartialEq<PerU16> for PerU16[src]

impl PartialOrd<PerU16> for PerU16[src]

impl PerThing for PerU16[src]

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

fn deconstruct(self) -> Self::Inner[src]

Consume self and return the number of parts per thing.

fn from_parts(parts: Self::Inner) -> Self[src]

Build this type from a number of parts per thing.

fn from_fraction(x: f64) -> Self[src]

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

impl Saturating for PerU16[src]

fn saturating_add(self, rhs: Self) -> Self[src]

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

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

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

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

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

impl Serialize for PerU16[src]

impl StructuralEq for PerU16[src]

impl StructuralPartialEq for PerU16[src]

Auto Trait Implementations

impl RefUnwindSafe for PerU16

impl Send for PerU16

impl Sync for PerU16

impl Unpin for PerU16

impl UnwindSafe for PerU16

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<S> Codec for S where
    S: Encode + Decode
[src]

impl<T> DecodeAll for T where
    T: Decode
[src]

impl<T> DecodeLimit for T where
    T: Decode
[src]

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

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

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

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

impl<T> EncodeLike<Arc<T>> for T where
    T: Encode
[src]

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

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

impl<T> EncodeLike<Rc<T>> for T where
    T: Encode
[src]

impl<T> From<T> for T[src]

impl<S> FullCodec for S where
    S: Decode + FullEncode
[src]

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

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>,
    Compact<T>: Clone,
    Compact<T>: PartialEq<Compact<T>>,
    Compact<T>: Eq,
    Compact<T>: MaybeDebugSerde, 
[src]

type Type = Compact<T>

The compact type; this can be

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> KeyedVec for T where
    T: Codec
[src]

impl<T> SaturatedConversion for T[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

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