Struct spl_math::precise_number::PreciseNumber

pub struct PreciseNumber {
    pub value: U256,
}

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

Fields

value: U256

Wrapper over the inner value, which is multiplied by ONE

Implementations

impl PreciseNumber

pub fn new(value: u128) -> Option<Self>

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

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

Convert a precise number back to u128

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

Checks that two PreciseNumbers are equal within some 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) -> Option<Self>

Floors a precise value to a precision of ONE

pub fn ceiling(&self) -> Option<Self>

Ceiling a precise value to a precision of ONE

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

Performs a checked division on two precise numbers

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

Performs a multiplication on two precise numbers

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

Performs addition of two precise numbers

pub fn checked_sub(&self, rhs: &Self) -> Option<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) -> Option<Self>

Performs pow on a precise number

pub fn sqrt(&self) -> Option<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 Clone for PreciseNumber

fn clone(&self) -> PreciseNumber

Returns a copy 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 PartialEq for PreciseNumber

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

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

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

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

impl StructuralPartialEq for PreciseNumber