Struct simple_soft_float::FloatProperties

pub struct FloatProperties { /* fields omitted */ }

properties of a particular floating-point format

Methods

impl FloatProperties

pub fn check_compatibility(
    self,
    other: Self
) -> Result<(), FloatPropertiesIncompatible>

check for compatibility between two FloatProperties values

pub const fn new_with_extended_flags(
    exponent_width: usize,
    mantissa_width: usize,
    has_implicit_leading_bit: bool,
    has_sign_bit: bool,
    platform_properties: PlatformProperties
) -> Self

create a new FloatProperties value

pub const fn new(exponent_width: usize, mantissa_width: usize) -> Self

create a new FloatProperties value

pub const fn new_with_platform_properties(
    exponent_width: usize,
    mantissa_width: usize,
    platform_properties: PlatformProperties
) -> Self

create a new FloatProperties value

pub const STANDARD_16: Self

FloatProperties for standard binary16 format

pub const STANDARD_32: Self

FloatProperties for standard binary32 format

pub const STANDARD_64: Self

FloatProperties for standard binary64 format

pub const STANDARD_128: Self

FloatProperties for standard binary128 format

pub const fn standard_16_with_platform_properties(
    platform_properties: PlatformProperties
) -> Self

FloatProperties for standard binary16 format

pub const fn standard_32_with_platform_properties(
    platform_properties: PlatformProperties
) -> Self

FloatProperties for standard binary32 format

pub const fn standard_64_with_platform_properties(
    platform_properties: PlatformProperties
) -> Self

FloatProperties for standard binary64 format

pub const fn standard_128_with_platform_properties(
    platform_properties: PlatformProperties
) -> Self

FloatProperties for standard binary128 format

pub fn standard_with_platform_properties(
    width: usize,
    platform_properties: PlatformProperties
) -> Option<Self>

construct FloatProperties for standard width-bit binary interchange format, if it exists

pub fn standard(width: usize) -> Option<Self>

construct FloatProperties for standard width-bit binary interchange format, if it exists

pub fn is_standard(self) -> bool

check if self is a standard binary interchange format.

pub const fn exponent_width(self) -> usize

the number of bits in the exponent field

pub const fn mantissa_width(self) -> usize

the number of bits in the mantissa field (excludes any implicit leading bit)

pub const fn has_implicit_leading_bit(self) -> bool

if the floating-point format uses an implicit leading bit

pub const fn has_sign_bit(self) -> bool

if the floating-point format has a sign bit

pub const fn platform_properties(self) -> PlatformProperties

get the PlatformProperties

pub fn quiet_nan_format(self) -> QuietNaNFormat

get the QuietNaNFormat

pub const fn width(self) -> usize

get the floating-point format's width in bits

pub const fn fraction_width(self) -> usize

get the number of bits after the radix point in the representation of normal floating-point values

pub const fn sign_field_shift(self) -> usize

get the amount by which the floating-point bits should be shifted right in order to extract the sign field.

the sign field can be extracted using (bits & sign_field_mask) >> sign_field_shift

pub fn sign_field_mask<Bits: FloatBitsType>(self) -> Bits

get the bitwise mask for the sign field (before shifting to extract).

the sign field can be extracted using (bits & sign_field_mask) >> sign_field_shift

pub const fn exponent_field_shift(self) -> usize

get the amount by which the floating-point bits should be shifted right in order to extract the exponent field.

the exponent field can be extracted using (bits & exponent_field_mask) >> exponent_field_shift

pub fn exponent_field_mask<Bits: FloatBitsType>(self) -> Bits

get the bitwise mask for the exponent field (before shifting to extract).

the exponent field can be extracted using (bits & exponent_field_mask) >> exponent_field_shift

pub const fn mantissa_field_shift(self) -> usize

get the amount by which the floating-point bits should be shifted right in order to extract the mantissa field.

the mantissa field can be extracted using (bits & mantissa_field_mask) >> mantissa_field_shift

pub fn mantissa_field_mask<Bits: FloatBitsType>(self) -> Bits

get the bitwise mask for the mantissa field (before shifting to extract).

the mantissa field can be extracted using (bits & mantissa_field_mask) >> mantissa_field_shift

pub fn mantissa_field_max<Bits: FloatBitsType>(self) -> Bits

get the maximum value of the mantissa field

pub fn mantissa_field_normal_min<Bits: FloatBitsType>(self) -> Bits

get the minimum value the mantissa field can take on for normal floating-point numbers.

pub const fn mantissa_field_msb_shift(self) -> usize

get the amount by which the floating-point bits should be shifted right in order to extract the mantissa field's MSB.

the mantissa field's MSB can be extracted using (bits & mantissa_field_msb_mask) >> mantissa_field_msb_shift

pub fn mantissa_field_msb_mask<Bits: FloatBitsType>(self) -> Bits

get the bitwise mask for the mantissa field's MSB (before shifting to extract).

the mantissa field's MSB can be extracted using (bits & mantissa_field_msb_mask) >> mantissa_field_msb_shift

pub fn exponent_bias<Bits: FloatBitsType>(self) -> Bits

get the amount by which the exponent field is offset from the mathematical exponent for normal floating-point numbers.

the mathematical exponent and the exponent field's values for normal floating-point numbers are related by the following equation: mathematical_exponent + exponent_bias == exponent_field

pub fn exponent_inf_nan<Bits: FloatBitsType>(self) -> Bits

get the value used in the exponent field for infinities and NaNs

pub fn exponent_zero_subnormal<Bits: FloatBitsType>(self) -> Bits

get the value used in the exponent field for zeros and subnormals

pub fn exponent_min_normal<Bits: FloatBitsType>(self) -> Bits

get the minimum value of the exponent field for normal floating-point numbers.

the mathematical exponent and the exponent field's values for normal floating-point numbers are related by the following equation: mathematical_exponent + exponent_bias == exponent_field

pub fn exponent_max_normal<Bits: FloatBitsType>(self) -> Bits

get the maximum value of the exponent field for normal floating-point numbers.

the mathematical exponent and the exponent field's values for normal floating-point numbers are related by the following equation: mathematical_exponent + exponent_bias == exponent_field

pub fn overall_mask<Bits: FloatBitsType>(self) -> Bits

get the mask for the whole floating-point format

Trait Implementations

impl Clone for FloatProperties

fn clone(&self) -> FloatProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FloatProperties

impl Debug for FloatProperties

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

Formats the value using the given formatter.

impl Eq for FloatProperties

impl FloatTraits for FloatProperties

type Bits = BigUint

the type used to represent bits for a floating-point format

fn properties(&self) -> FloatProperties

get the FloatProperties value

impl Hash for FloatProperties

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<FloatProperties> for FloatProperties

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

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

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

This method tests for !=.

impl StructuralEq for FloatProperties

impl StructuralPartialEq for FloatProperties