Trait sp_arithmetic::FixedPointNumber

pub trait FixedPointNumber: Sized + Copy + Default + Debug + Saturating + Bounded + Eq + PartialEq + Ord + PartialOrd + CheckedSub + CheckedAdd + CheckedMul + CheckedDiv + Add + Sub + Div + Mul {
    type Inner: Debug + One + CheckedMul + CheckedDiv + FixedPointOperand;

    pub const DIV: Self::Inner;
    pub const SIGNED: bool;

    pub fn from_inner(int: Self::Inner) -> Self;
    pub fn into_inner(self) -> Self::Inner;

    pub fn accuracy() -> Self::Inner { ... }
    pub fn saturating_from_integer<N: FixedPointOperand>(int: N) -> Self { ... }
    pub fn checked_from_integer(int: Self::Inner) -> Option<Self> { ... }
    pub fn saturating_from_rational<N: FixedPointOperand, D: FixedPointOperand>(
        n: N, 
        d: D
    ) -> Self { ... }
    pub fn checked_from_rational<N: FixedPointOperand, D: FixedPointOperand>(
        n: N, 
        d: D
    ) -> Option<Self> { ... }
    pub fn checked_mul_int<N: FixedPointOperand>(self, n: N) -> Option<N> { ... }
    pub fn saturating_mul_int<N: FixedPointOperand>(self, n: N) -> N { ... }
    pub fn checked_div_int<N: FixedPointOperand>(self, d: N) -> Option<N> { ... }
    pub fn saturating_div_int<N: FixedPointOperand>(self, d: N) -> N { ... }
    pub fn saturating_mul_acc_int<N: FixedPointOperand>(self, n: N) -> N { ... }
    pub fn saturating_abs(self) -> Self { ... }
    pub fn reciprocal(self) -> Option<Self> { ... }
    pub fn zero() -> Self { ... }
    pub fn is_zero(&self) -> bool { ... }
    pub fn one() -> Self { ... }
    pub fn is_one(&self) -> bool { ... }
    pub fn is_positive(self) -> bool { ... }
    pub fn is_negative(self) -> bool { ... }
    pub fn trunc(self) -> Self { ... }
    pub fn frac(self) -> Self { ... }
    pub fn ceil(self) -> Self { ... }
    pub fn floor(self) -> Self { ... }
    pub fn round(self) -> Self { ... }
}

Something that implements a decimal fixed point number.

The precision is given by Self::DIV, i.e. 1 / DIV can be represented.

Each type can store numbers from Self::Inner::min_value() / Self::DIV to Self::Inner::max_value() / Self::DIV. This is also referred to as the accuracy of the type in the documentation.

Associated Types

type Inner: Debug + One + CheckedMul + CheckedDiv + FixedPointOperand

The underlying data type used for this fixed point number.

Loading content...

Associated Constants

pub const DIV: Self::Inner

Precision of this fixed point implementation. It should be a power of 10.

pub const SIGNED: bool

Indicates if this fixed point implementation is signed or not.

Loading content...

Required methods

pub fn from_inner(int: Self::Inner) -> Self

Builds this type from an integer number.

pub fn into_inner(self) -> Self::Inner

Consumes self and returns the inner raw value.

Loading content...

Provided methods

pub fn accuracy() -> Self::Inner

Precision of this fixed point implementation.

pub fn saturating_from_integer<N: FixedPointOperand>(int: N) -> Self

Creates self from an integer number int.

Returns Self::max or Self::min if int exceeds accuracy.

pub fn checked_from_integer(int: Self::Inner) -> Option<Self>

Creates self from an integer number int.

Returns None if int exceeds accuracy.

pub fn saturating_from_rational<N: FixedPointOperand, D: FixedPointOperand>(
    n: N,
    d: D
) -> Self

Creates self from a rational number. Equal to n / d.

Panics if d = 0. Returns Self::max or Self::min if n / d exceeds accuracy.

pub fn checked_from_rational<N: FixedPointOperand, D: FixedPointOperand>(
    n: N,
    d: D
) -> Option<Self>

Creates self from a rational number. Equal to n / d.

Returns None if d == 0 or n / d exceeds accuracy.

pub fn checked_mul_int<N: FixedPointOperand>(self, n: N) -> Option<N>

Checked multiplication for integer type N. Equal to self * n.

Returns None if the result does not fit in N.

pub fn saturating_mul_int<N: FixedPointOperand>(self, n: N) -> N

Saturating multiplication for integer type N. Equal to self * n.

Returns N::min or N::max if the result does not fit in N.

pub fn checked_div_int<N: FixedPointOperand>(self, d: N) -> Option<N>

Checked division for integer type N. Equal to self / d.

Returns None if the result does not fit in N or d == 0.

pub fn saturating_div_int<N: FixedPointOperand>(self, d: N) -> N

Saturating division for integer type N. Equal to self / d.

Panics if d == 0. Returns N::min or N::max if the result does not fit in N.

pub fn saturating_mul_acc_int<N: FixedPointOperand>(self, n: N) -> N

Saturating multiplication for integer type N, adding the result back. Equal to self * n + n.

Returns N::min or N::max if the multiplication or final result does not fit in N.

pub fn saturating_abs(self) -> Self

Saturating absolute value.

Returns Self::max if self == Self::min.

pub fn reciprocal(self) -> Option<Self>

Takes the reciprocal (inverse). Equal to 1 / self.

Returns None if self = 0.

pub fn zero() -> Self

Returns zero.

pub fn is_zero(&self) -> bool

Checks if the number is zero.

pub fn one() -> Self

Returns one.

pub fn is_one(&self) -> bool

Checks if the number is one.

pub fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

pub fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

pub fn trunc(self) -> Self

Returns the integer part.

pub fn frac(self) -> Self

Returns the fractional part.

Note: the returned fraction will be non-negative for negative numbers, except in the case where the integer part is zero.

pub fn ceil(self) -> Self

Returns the smallest integer greater than or equal to a number.

Saturates to Self::max (truncated) if the result does not fit.

pub fn floor(self) -> Self

Returns the largest integer less than or equal to a number.

Saturates to Self::min (truncated) if the result does not fit.

pub fn round(self) -> Self

Returns the number rounded to the nearest integer. Rounds half-way cases away from 0.0.

Saturates to Self::min or Self::max (truncated) if the result does not fit.

Loading content...

Implementors

impl FixedPointNumber for FixedI64

type Inner = i64

pub const DIV: Self::Inner

pub const SIGNED: bool

pub fn from_inner(inner: Self::Inner) -> Self

pub fn into_inner(self) -> Self::Inner

impl FixedPointNumber for FixedI128

type Inner = i128

pub const DIV: Self::Inner

pub const SIGNED: bool

pub fn from_inner(inner: Self::Inner) -> Self

pub fn into_inner(self) -> Self::Inner

impl FixedPointNumber for FixedU128

type Inner = u128

pub const DIV: Self::Inner

pub const SIGNED: bool

pub fn from_inner(inner: Self::Inner) -> Self

pub fn into_inner(self) -> Self::Inner

Loading content...