Struct XFL

pub struct XFL(pub i64);

Abstraction of XFL floating point numbers. The struct is overloaded with basic numeric operations, such as addition, subtraction, multiplication, division, and negation. Comparison operators are also implemented.

Tuple Fields

0: i64

Implementations

impl XFL

pub fn new(exponent: i32, mantissa: i64) -> Result<Self>

Create a new XFL number from an exponent and mantissa

Example

let plus_1000 = XFL::new(-12, 1000000000000000).unwrap_line_number();

pub fn from_sto(serialized_xfl: &[u8; 8]) -> Result<Self>

Read a serialized XFL amount into an XFL

pub fn one() -> Self

Return the number 1 represented in an XFL enclosing number

Example

let half = XFL::one().mulratio(false, 1, 2)

pub fn to_int64(&self, decimal_places: u32, is_absolute: bool) -> Result<i64>

Convert an XFL floating point into an integer (floor). The behavior is as follows:

1. Left shift (multiply by 10) the XFL by the number of specified decimal places
2. Convert the resulting XFL to an integer, discarding any remainder
3. Return the integer

Example

let approx_pi = XFL::new(-15, 3140000000000000).unwrap_line_number();

if 3 != approx_pi.to_int64(0, false).unwrap_line_number() {
    rollback(b"incorect rounding", line!().into());
}

pub fn exponent(&self) -> i64

Get the exponent of an XFL enclosing number

Example

let plus_998 = XFL::new(-13, 9980000000000000).unwrap_line_number();

if plus_998.exponent() != -13 {
    rollback(b"exponent incorrect", line!().into());
}

pub fn mantissa(&self) -> i64

Get the exponent of an XFL enclosing number

Example

let plus_998 = XFL::new(-13, 9980000000000000).unwrap_line_number();

if plus_998.mantissa() != 9980000000000000 {
    rollback(b"mantissa incorrect", line!().into());
}

pub fn mulratio( &self, round_up: bool, numerator: u32, denominator: u32, ) -> Result<XFL>

Multiply an XFL floating point by a non-XFL numerator and denominator

Example

if XFL::one().mulratio(false, 1, 2).unwrap_line_number()
    != XFL::one().mulratio(false, 5, 10).unwrap_line_number()
{
    rollback(b"", line!().into());
}

Trait Implementations

impl Add for XFL

type Output = Result<XFL>

The resulting type after applying the + operator.

fn add(self, other: XFL) -> Self::Output

Performs the + operation.

impl Clone for XFL

fn clone(&self) -> XFL

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Div for XFL

type Output = Result<XFL>

The resulting type after applying the / operator.

fn div(self, other: XFL) -> Self::Output

Performs the / operation.

impl Mul for XFL

type Output = Result<XFL>

The resulting type after applying the * operator.

fn mul(self, other: XFL) -> Self::Output

Performs the * operation.

impl Neg for XFL

type Output = Result<XFL>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for XFL

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

fn partial_cmp(&self, other: &Self) -> 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 XFL

type Output = Result<XFL>

The resulting type after applying the - operator.

fn sub(self, other: XFL) -> Self::Output

Performs the - operation.

impl Copy for XFL