Struct artichoke_backend::extn::core::float::Float

pub struct Float(_);

Implementations

impl Float

pub const DIG: Int

The minimum number of significant decimal digits in a double-precision floating point.

Usually defaults to 15.

pub const EPSILON: Fp

The difference between 1 and the smallest double-precision floating point number greater than 1.

Usually defaults to 2.2204460492503131e-16.

pub const INFINITY: Fp

An expression representing positive infinity.

pub const MANT_DIG: Int

The minimum number of significant decimal digits in a double-precision floating point.

Usually defaults to 15.

pub const MAX: Fp

The largest possible integer in a double-precision floating point number.

Usually defaults to 1.7976931348623157e+308.

pub const MAX_10_EXP: Int

The largest positive exponent in a double-precision floating point where 10 raised to this power minus 1.

Usually defaults to 308.

pub const MAX_EXP: Int

The largest possible exponent value in a double-precision floating point.

Usually defaults to 1024.

pub const MIN: Fp

The smallest positive normalized number in a double-precision floating point.

Usually defaults to 2.2250738585072014e-308.

If the platform supports denormalized numbers, there are numbers between zero and Float::MIN. 0.0.next_float returns the smallest positive floating point number including denormalized numbers.

pub const MIN_10_EXP: Int

The smallest negative exponent in a double-precision floating point where 10 raised to this power minus 1.

Usually defaults to -307.

pub const MIN_EXP: Int

The smallest possible exponent value in a double-precision floating point.

Usually defaults to -1021.

pub const NAN: Fp

An expression representing a value which is "not a number".

pub const NEG_INFINITY: Fp

pub const RADIX: Int

The base of the floating point, or number of unique digits used to represent the number.

Usually defaults to 2 on most systems, which would represent a base-10 decimal.

pub const ROUNDS: Int

Represents the rounding mode for floating point addition.

Usually defaults to 1, rounding to the nearest number.

Other modes include:

mode	value
Indeterminable	-1
Rounding towards zero	0
Rounding to the nearest number	1
Rounding towards positive infinity	2
Rounding towards negative infinity	3

Rust Caveats

Rust does not support setting the rounding mode and the behavior from LLVM is not documented. Because of this uncertainty, Artichoke sets its rounding mode to -1, Indeterminable.

The Rust docs say f64::round rounds "half-way cases away from 0.0." Stack Overflow has a discussion around float rounding semantics in Rust and LLVM.

#[must_use]pub const fn new() -> Self

Construct a new, zero, float.

#[must_use]pub const fn as_f64(self) -> f64

Return the inner f64.

#[must_use]pub fn modulo(self, other: Self) -> Self

Compute the remainder of self and other.

Equivalent to self.as_f64() % other.as_f64().

pub fn coerced_modulo(
    self,
    interp: &mut Artichoke,
    other: Value
) -> Result<Outcome, Error>

Trait Implementations

impl Clone for Float

fn clone(&self) -> Float

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConvertMut<Float, Value> for Artichoke

fn convert_mut(&mut self, from: Float) -> Value

Performs the infallible conversion.

impl Copy for Float

impl Debug for Float

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

Formats the value using the given formatter.

impl Default for Float

fn default() -> Float

Returns the "default value" for a type.

impl From<Float> for Fp

fn from(flt: Float) -> Self

Performs the conversion.

impl From<Float> for Outcome

fn from(flt: Float) -> Self

Performs the conversion.

impl From<f64> for Float

fn from(flt: Fp) -> Self

Performs the conversion.

impl PartialEq<Float> for Float

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

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

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

This method tests for !=.

impl PartialOrd<Float> for Float

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

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

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

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

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

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

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

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

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

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

impl StructuralPartialEq for Float

impl TryConvert<Value, Float> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: Value) -> Result<Float, Self::Error>

Performs the fallible conversion.