Struct sp_arithmetic::Fixed64

pub struct Fixed64(_);

An unsigned fixed point number. Can hold any value in the range [-9_223_372_036, 9_223_372_036] with fixed point accuracy of one billion.

Methods

impl Fixed64

pub fn from_natural(int: i64) -> Self

creates self from a natural number.

Note that this might be lossy.

pub fn accuracy() -> i64

Return the accuracy of the type. Given that this function returns the value X, it means that an instance composed of X parts (Fixed64::from_parts(X)) is equal to 1.

pub fn into_inner(self) -> i64

Consume self and return the inner value.

This should only be used for testing.

pub fn from_parts(parts: i64) -> Self

Raw constructor. Equal to parts / 1_000_000_000.

pub fn from_rational(n: i64, d: u64) -> Self

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

Note that this might be lossy.

pub fn saturated_multiply_accumulate<N>(self, int: N) -> N where
    N: TryFrom<u64> + From<u32> + UniqueSaturatedInto<u32> + Bounded + Clone + Saturating + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N>, 

Performs a saturated multiply and accumulate by unsigned number.

Returns a saturated int + (self * int).

Trait Implementations

impl Add<Fixed64> for Fixed64

Note that this is a standard, potentially-panicking, implementation. Use Saturating trait for safe addition.

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl CheckedAdd for Fixed64

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

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

impl CheckedDiv for Fixed64

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

Divides two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl CheckedSub for Fixed64

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

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

impl Clone for Fixed64

fn clone(&self) -> Fixed64

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Fixed64

impl Debug for Fixed64

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Decode for Fixed64

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

Attempt to deserialise the value from input.

impl Default for Fixed64

fn default() -> Fixed64

Returns the "default value" for a type.

impl Div<Fixed64> for Fixed64

Note that this is a standard, potentially-panicking, implementation. Use CheckedDiv trait for safe division.

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Encode for Fixed64

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

impl Eq for Fixed64

impl Ord for Fixed64

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

#[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<Fixed64> for Fixed64

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

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

fn ne(&self, other: &Fixed64) -> bool

This method tests for !=.

impl PartialOrd<Fixed64> for Fixed64

fn partial_cmp(&self, other: &Fixed64) -> Option<Ordering>

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

fn lt(&self, other: &Fixed64) -> bool

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

fn le(&self, other: &Fixed64) -> bool

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

fn gt(&self, other: &Fixed64) -> bool

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

fn ge(&self, other: &Fixed64) -> bool

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

impl Saturating for Fixed64

fn saturating_add(self, rhs: Self) -> Self

Saturated addition - if the product can't fit in the type then just use max-value.

fn saturating_mul(self, rhs: Self) -> Self

Saturated multiply - if the product can't fit in the type then just use max-value.

fn saturating_sub(self, rhs: Self) -> Self

Saturated subtraction - if the product can't fit in the type then just use max-value.

impl StructuralEq for Fixed64

impl StructuralPartialEq for Fixed64

impl Sub<Fixed64> for Fixed64

Note that this is a standard, potentially-panicking, implementation. Use Saturating trait for safe subtraction.

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.