Trait compiler_builtins::float::Float

source ·

pub(crate) trait Float: Copy + Debug + PartialEq + PartialOrd + AddAssign + MulAssign + Add<Output = Self> + Sub<Output = Self> + Div<Output = Self> + Rem<Output = Self> {
    type Int: Int;
    type SignedInt: Int;
    type ExpInt: Int;
Show 11 associated constants and 11 methods
    const ZERO: Self;
    const ONE: Self;
    const BITS: u32;
    const SIGNIFICAND_BITS: u32;
    const SIGN_MASK: Self::Int;
    const SIGNIFICAND_MASK: Self::Int;
    const IMPLICIT_BIT: Self::Int;
    const EXPONENT_MASK: Self::Int;
    const EXPONENT_BITS: u32 = _;
    const EXPONENT_MAX: u32 = _;
    const EXPONENT_BIAS: u32 = _;

    // Required methods
    fn repr(self) -> Self::Int;
    fn signed_repr(self) -> Self::SignedInt;
    fn eq_repr(self, rhs: Self) -> bool;
    fn sign(self) -> bool;
    fn exp(self) -> Self::ExpInt;
    fn frac(self) -> Self::Int;
    fn imp_frac(self) -> Self::Int;
    fn from_repr(a: Self::Int) -> Self;
    fn from_parts(
        sign: bool,
        exponent: Self::Int,
        significand: Self::Int
    ) -> Self;
    fn normalize(significand: Self::Int) -> (i32, Self::Int);
    fn is_subnormal(self) -> bool;
}

Expand description

Trait for some basic operations on floats

Required Associated Types§

source

type Int: Int

A uint of the same width as the float

source

type SignedInt: Int

A int of the same width as the float

source

type ExpInt: Int

An int capable of containing the exponent bits plus a sign bit. This is signed.

Required Associated Constants§

source

const ZERO: Self

source

const ONE: Self

source

const BITS: u32

The bitwidth of the float type

source

const SIGNIFICAND_BITS: u32

The bitwidth of the significand

source

const SIGN_MASK: Self::Int

A mask for the sign bit

source

const SIGNIFICAND_MASK: Self::Int

A mask for the significand

source

const IMPLICIT_BIT: Self::Int

source

const EXPONENT_MASK: Self::Int

A mask for the exponent

Provided Associated Constants§

source

const EXPONENT_BITS: u32 = _

The bitwidth of the exponent

source

const EXPONENT_MAX: u32 = _

The maximum value of the exponent

source

const EXPONENT_BIAS: u32 = _

The exponent bias value

Required Methods§

source

fn repr(self) -> Self::Int

Returns self transmuted to Self::Int

source

fn signed_repr(self) -> Self::SignedInt

Returns self transmuted to Self::SignedInt

source

fn eq_repr(self, rhs: Self) -> bool

Checks if two floats have the same bit representation. Except for NaNs! NaN can be represented in multiple different ways. This method returns true if two NaNs are compared.

source