Struct Ieee64

#[repr(C)]
pub struct Ieee64 { /* private fields */ }

An IEEE binary64 immediate floating point value, represented as a u64 containing the bit pattern.

We specifically avoid using a f64 here since some architectures may silently alter floats. See: https://github.com/bytecodealliance/wasmtime/pull/2251#discussion_r498508646

The PartialEq and Hash implementations are over the underlying bit pattern, but PartialOrd respects IEEE754 semantics.

All bit patterns are allowed.

Implementations

impl Ieee64

pub const NAN: Self = _

The positive WebAssembly canonical NaN.

pub const fn with_bits(bits: u64) -> Self

Create a new Ieee64 containing the bits of bits.

pub fn bits(self) -> u64

Get the bitwise representation.

pub fn with_float(x: f64) -> Self

Create a new Ieee64 representing the number x.

pub fn as_f64(self) -> f64

Converts self to a Rust f64.

pub fn abs(self) -> Self

Computes the absolute value of self.

pub fn copysign(self, sign: Self) -> Self

Returns a number composed of the magnitude of self and the sign of sign.

pub fn minimum(self, other: Self) -> Self

Returns the minimum of self and other, following the WebAssembly/IEEE 754-2019 definition.

pub fn maximum(self, other: Self) -> Self

Returns the maximum of self and other, following the WebAssembly/IEEE 754-2019 definition.

pub fn pow2<I: Into<i32>>(n: I) -> Self

Create an Ieee64 number representing 2.0^n.

pub fn fcvt_to_sint_negative_overflow<I: Into<i32>>(n: I) -> Self

Create an Ieee64 number representing the greatest negative value not convertible from f64 to a signed integer with width n.

pub fn is_nan(self) -> bool

Check if the value is a NaN. For Ieee64, this means checking that all the exponent bits are set and the significand is non-zero.

pub fn is_positive(self) -> bool

Returns true if self has a negative sign, including 0.0, NaNs with positive sign bit and positive infinity.

pub fn is_negative(self) -> bool

Returns true if self has a negative sign, including -0.0, NaNs with negative sign bit and negative infinity.

pub fn is_zero(self) -> bool

Returns true if self is positive or negative zero.

pub fn non_nan(self) -> Option<Self>

Returns None if self is a NaN and Some(self) otherwise.

pub fn sqrt(self) -> Self

Returns the square root of self.

pub fn ceil(self) -> Self

Returns the smallest integer greater than or equal to self.

pub fn floor(self) -> Self

Returns the largest integer less than or equal to self.

pub fn trunc(self) -> Self

Returns the integer part of self. This means that non-integer numbers are always truncated towards zero.

pub fn round_ties_even(self) -> Self

Returns the nearest integer to self. Rounds half-way cases to the number with an even least significant digit.

Trait Implementations

impl Add for Ieee64

type Output = Ieee64

The resulting type after applying the + operator.

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

Performs the + operation.

impl BitAnd for Ieee64

type Output = Ieee64

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl BitOr for Ieee64

type Output = Ieee64

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitXor for Ieee64

type Output = Ieee64

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

impl Clone for Ieee64

fn clone(&self) -> Ieee64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ieee64

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

Formats the value using the given formatter.

impl Display for Ieee64

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

Formats the value using the given formatter.

impl Div for Ieee64

type Output = Ieee64

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<Ieee64> for DataValue

fn from(data: Ieee64) -> Self

Converts to this type from the input type.

impl From<f64> for Ieee64

fn from(x: f64) -> Self

Converts to this type from the input type.

impl FromStr for Ieee64

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, &'static str>

Parses a string s to return a value of this type.

impl Hash for Ieee64

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoBytes for Ieee64

fn into_bytes(self) -> Vec<u8>

Return the little-endian byte representation of the implementing type.

impl Mul for Ieee64

type Output = Ieee64

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Ieee64

type Output = Ieee64

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Not for Ieee64

type Output = Ieee64

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl PartialEq for Ieee64

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

fn partial_cmp(&self, rhs: &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 Ieee64

type Output = Ieee64

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryInto<Ieee64> for DataValue

type Error = DataValueCastFailure

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Ieee64, Self::Error>

Performs the conversion.

impl Copy for Ieee64

impl Eq for Ieee64

impl StructuralPartialEq for Ieee64