Struct PreciseNumber 

pub struct PreciseNumber {
    pub val: U256,
}

Struct encapsulating a fixed-point number that allows for decimal calculations

Fields

val: U256

Wrapper over the inner value, which is multiplied by ONE

Implementations

impl PreciseNumber

pub fn zero() -> Self

pub fn one() -> Self

pub fn new(val: u128) -> Result<Self>

Create a precise number from an imprecise u128, should always succeed

pub fn from(val: u128) -> Self

Create a precise number from a precise u128.

pub fn from_bps(bps: u16) -> Result<Self>

Create a precise number from a basis points number.

pub fn from_decimal(decimal: u128, exponent: i32) -> Result<Self>

Create a precise number from a decimal number using exponent to adjust precision.

pub fn to_imprecise(&self) -> Result<u128>

Convert a precise number back to u128

pub fn to_imprecise_u64(&self) -> Result<u64>

Convert a precise number back to u64

pub fn mul_up(self, rhs: Self) -> Result<Self>

pub fn div_up(self, rhs: Self) -> Result<Self>

pub fn almost_eq(&self, rhs: &Self, precision: U256) -> bool

Checks that two PreciseNumbers are equal within Ok tolerance

pub fn less_than(&self, rhs: &Self) -> bool

Checks that a number is less than another

pub fn greater_than(&self, rhs: &Self) -> bool

Checks that a number is greater than another

pub fn less_than_or_equal(&self, rhs: &Self) -> bool

Checks that a number is less than another

pub fn greater_than_or_equal(&self, rhs: &Self) -> bool

Checks that a number is greater than another

pub fn floor(&self) -> Result<Self>

Floors a precise value to a precision of ONE

pub fn ceil(&self) -> Result<Self>

Ceiling a precise value to a precision of ONE

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

Performs a checked division on two precise numbers

pub fn checked_mul(&self, rhs: &Self) -> Result<Self>

Performs a multiplication on two precise numbers

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

Performs addition of two precise numbers

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

Subtracts the argument from self

pub fn unsigned_sub(&self, rhs: &Self) -> (Self, bool)

Performs a subtraction, returning the result and whether the result is negative

pub fn checked_pow(&self, exponent: u128) -> Result<Self>

Performs pow on a precise number

pub fn sqrt(&self) -> Result<Self>

Approximate the square root using Newton’s method. Based on testing, this provides a precision of 11 digits for inputs between 0 and u128::MAX

Trait Implementations

impl Add for PreciseNumber

type Output = PreciseNumber

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for PreciseNumber

fn add_assign(&mut self, rhs: PreciseNumber)

Performs the += operation.

impl Clone for PreciseNumber

fn clone(&self) -> PreciseNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PreciseNumber

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

Formats the value using the given formatter.

impl Default for PreciseNumber

fn default() -> PreciseNumber

Returns the “default value” for a type.

impl Div for PreciseNumber

type Output = PreciseNumber

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for PreciseNumber

fn div_assign(&mut self, rhs: PreciseNumber)

Performs the /= operation.

impl Mul for PreciseNumber

type Output = PreciseNumber

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for PreciseNumber

fn mul_assign(&mut self, rhs: PreciseNumber)

Performs the *= operation.

impl Ord for PreciseNumber

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

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

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

type Output = PreciseNumber

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for PreciseNumber

fn sub_assign(&mut self, rhs: PreciseNumber)

Performs the -= operation.

impl Copy for PreciseNumber

impl Eq for PreciseNumber

impl StructuralPartialEq for PreciseNumber