Struct FixedPoint 

pub struct FixedPoint(/* private fields */);

Represents a rational number deterministically. Internally, numbers are represented by an integer x: i128, which represents the real x / (2 ** 64).

Addition, multiplication, and division are defined; as this is used for cost estimations, addition and multiplication are saturating (because the maximum should always be rejected), and division rounds up.

Implementations

impl FixedPoint

pub const ZERO: FixedPoint

The value of 0.0

pub const ONE: FixedPoint

The value of 1.0

pub const MIN_POSITIVE: FixedPoint

The smallest positive fraction representable in this fixed point representation

pub const MAX: FixedPoint

The maximum representable fixed point number

pub fn into_atomic_units(self, base_unit: u128) -> u128

Takes a FixedPoint denominated in a non-base token unit (for instance, 1.0 representing DUST) to it’s base unit.

Conceptually, acts as self * base_unit as u128 with smarter overflow handling.

Rounds up, and returns zero for negatives.

pub fn powi(self, exp: i32) -> Self

Raises the number to an integer power.

pub const fn from_u64_div(a: u64, b: u64) -> FixedPoint

Instantiates a fixed point from a/b (rounded up to the nearest 2^-64)

Unlike FixedPoint::from_u128_div, this method is const, due to using only builtin rust arithmetic operations.

pub fn from_u128_div(a: u128, b: u128) -> FixedPoint

Instantiates a fixed point from a/b (rounded up to the nearest 2^-64)

Trait Implementations

impl Add for FixedPoint

type Output = FixedPoint

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for FixedPoint

fn clone(&self) -> FixedPoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FixedPoint

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

Formats the value using the given formatter.

impl Deserializable for FixedPoint

fn deserialize( reader: &mut impl Read, recursion_depth: u32, ) -> Result<Self, Error>

const LIMIT_RECURSION: bool = true

fn check_rec(depth: &mut u32) -> Result<(), Error>

impl<'de> Deserialize<'de> for FixedPoint

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div for FixedPoint

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

Division rounding up to the nearest 2^-64

type Output = FixedPoint

The resulting type after applying the / operator.

impl From<FixedPoint> for f64

fn from(fp: FixedPoint) -> f64

Converts to this type from the input type.

impl From<FixedPoint> for i128

fn from(fp: FixedPoint) -> i128

Converts to this type from the input type.

impl From<f64> for FixedPoint

fn from(float: f64) -> FixedPoint

Converts to this type from the input type.

impl Mul for FixedPoint

type Output = FixedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for FixedPoint

type Output = FixedPoint

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for FixedPoint

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FixedPoint

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FixedPoint

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serializable for FixedPoint

fn serialize(&self, writer: &mut impl Write) -> Result<(), Error>

fn serialized_size(&self) -> usize

impl Serialize for FixedPoint

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for FixedPoint

type Output = FixedPoint

The resulting type after applying the - operator.

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

Performs the - operation.

impl Tagged for FixedPoint

fn tag() -> Cow<'static, str>

Retrieves the tag of Self. Returns a [Cow] as type arguments require allocation, but no allocation is preferred.

fn tag_unique_factor() -> String

A decomposition of this tag into primitive types (any type whose representation is not defined through other types), tuples (via (a,b)), and sum types (via [a,b]).

impl Copy for FixedPoint

impl Eq for FixedPoint

impl StructuralPartialEq for FixedPoint