Enum mpmfnum::rfloat::RFloat

pub enum RFloat {
    Real(bool, isize, Integer),
    PosInfinity,
    NegInfinity,
    Nan,
}

An arbitrary-precision, floating-point numbers with unbounded exponent.

The associated RoundingContext implementation is RFloatContext. See RFloatContext for more details on numerical properties of the RFloat type.

All operations canonicalize -0 to +0 (no sign bit).

Variants

Real(bool, isize, Integer)

A finite (real) number specified by the canonical triple of sign, exponent, significand.

PosInfinity

A positive infinity.

NegInfinity

A negative infinity.

Nan

Not a real number; either an undefined or infinte result.

Implementations

impl RFloat

pub fn zero() -> Self

Constructs the canonical zero for this format.

pub fn one() -> Self

Constructs the canonical +1 for this format.

pub fn is_nan(&self) -> bool

Returns true if the value is not-a-number.

pub fn canonicalize(&self) -> Self

Canonicalizes this number. All zeros are mapped to +0.0.

pub fn get_bit(&self, n: isize) -> Option<bool>

Returns the nth absolute binary digit. Only well-defined for finite, non-zero numbers.

pub fn from_number<N: Real>(val: &N) -> Self

Constructs a [ RFloat] value from a [Real]. This is the default conversion function from any implementation of the [Real`] trait.

Trait Implementations

impl Add for RFloat

type Output = RFloat

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for RFloat

fn clone(&self) -> RFloat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RFloat

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

Formats the value using the given formatter.

impl From<Fixed> for RFloat

fn from(val: Fixed) -> Self

Converts to this type from the input type.

impl From<Float> for RFloat

fn from(value: Float) -> Self

Converts to this type from the input type.

impl From<Float> for RFloat

fn from(val: Float) -> Self

Converts to this type from the input type.

impl From<IEEE754> for RFloat

fn from(val: IEEE754) -> Self

Converts to this type from the input type.

impl From<Posit> for RFloat

fn from(value: Posit) -> Self

Converts to this type from the input type.

impl From<RFloat> for Float

fn from(val: RFloat) -> Self

Converts to this type from the input type.

impl Mul for RFloat

type Output = RFloat

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for RFloat

type Output = RFloat

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for RFloat

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

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

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

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

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

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

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

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

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

impl Real for RFloat

fn radix() -> usize

Radix of a number. It must be strictly positive.

fn sign(&self) -> Option<bool>

The sign bit. This is not always well-defined, so the result is an Option. This is distinct from is_negative (e.g. -0.0 is not negative).

fn exp(&self) -> Option<isize>

The exponent of this number when viewed as (-1)^s * c * b^exp where c is an integer integer. Only well-defined for finite, non-zero numbers.

fn e(&self) -> Option<isize>

The exponent of this number when viewed as (-1)^s * f * b^e where f is a fraction between 1 and 2. This is the preferred IEEE 754 interpretation of an exponent. Only well-defined for finite, non-zero numbers.

fn n(&self) -> Option<isize>

The “absolute digit”, the place below the least significant digit of the mantissa. Always equal to self.exp() - 1. For integer formats, this is just -1. Only well-defined for finite, non-zero numbers.

fn c(&self) -> Option<Integer>

The _unsigned“ integer significand of this number when viewed as (-1)^s * c * b^exp. Only well-defined for finite, non-zero numbers. Only well-defined for finite, non-zero numbers.

fn m(&self) -> Option<Integer>

The signed integer significand of this number when viewed as (-1)^s * c * b^exp. Only well-defined for finite, non-zero numbers. Only well-defined for finite, non-zero numbers.

fn prec(&self) -> Option<usize>

Precision of the significand. This is just floor(logb(c)) where b is the radix and c is the integer significand. Only well-defined for finite, non-zero numbers.

fn is_nar(&self) -> bool

Returns true if this number is not a real number. Example: NaN or +/-Inf from the IEEE 754 standard.

fn is_finite(&self) -> bool

Returns true if this number is finite. For values that do not encode numbers, intervals, or even limiting behavior, the result is false.

fn is_infinite(&self) -> bool

Returns true if this number if infinite. For values that do not encode numbers, intervals, or even limiting behavior, the result is false.

fn is_zero(&self) -> bool

Returns true if this number is zero.

fn is_negative(&self) -> Option<bool>

Returns true if this number is negative. This is not always well-defined, so the result is an Option. This is not necessarily the same as the sign bit (the IEEE 754 standard differentiates between -0.0 and +0.0).

fn is_numerical(&self) -> bool

Returns true if this number represents a numerical value: either a finite number, interval, or some limiting value.

fn split(&self, n: isize) -> (RFloat, RFloat)

Splits this value at the nth binary digit, returning two RFloat values.

impl Sub for RFloat

type Output = RFloat

The resulting type after applying the - operator.

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

Performs the - operation.