Struct F64

pub struct F64(/* private fields */);

A 64-bit IBM floating point number.

This type supports the conversions:

• Transmuting to/from a u64 via from_bits(), to_bits()
• Transmuting to/from a big-endian [u8; 8] via from_be_bytes()/to_be_bytes()
• Lossily converting to an f32 via From/Into
• Lossily converting to an f64 via From/Into

IBM F64 floats have slightly more precision than IEEE-754 f64 floats, but they cover a slightly smaller domain. Most conversions will require rounding, but there is no risk of overflow or underflow.

let foreign_float = ibmfloat::F64::from_bits(0x4110000000000000);

let native_float = f64::from(foreign_float);
assert_eq!(native_float, 1.0f64);

let native_float: f64 = foreign_float.into();
assert_eq!(native_float, 1.0f64);

Implementations

impl F64

pub fn from_bits(value: u64) -> Self

Transmute a native-endian u64 into an F64.

let foreign_float = ibmfloat::F64::from_bits(0x4110000000000000);

let native_float = f64::from(foreign_float);
assert_eq!(native_float, 1.0f64);

pub fn to_bits(self) -> u64

Transmute this F64 to a native-endian u64.

let foreign_float = ibmfloat::F64::from_bits(0x4110000000000000);

assert_eq!(foreign_float.to_bits(), 0x4110000000000000);

pub fn from_be_bytes(bytes: [u8; 8]) -> Self

Create a floating point value from its representation as a byte array in big endian.

let foreign_float = ibmfloat::F64::from_be_bytes([0x41, 0x10, 0, 0, 0, 0, 0, 0]);

assert_eq!(foreign_float.to_bits(), 0x4110000000000000);

let native_float = f64::from(foreign_float);
assert_eq!(native_float, 1.0f64);

pub fn to_be_bytes(self) -> [u8; 8]

Return the memory representation of this floating point number as a byte array in big-endian (network) byte order.

let foreign_float = ibmfloat::F64::from_bits(0x4110000000000000);

assert_eq!(foreign_float.to_be_bytes(), [0x41, 0x10, 0, 0, 0, 0, 0, 0]);

Trait Implementations

impl Clone for F64

fn clone(&self) -> F64

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for F64

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

Formats the value using the given formatter.

impl From<F64> for f32

fn from(v: F64) -> Self

Converts to this type from the input type.

impl From<F64> for f64

fn from(v: F64) -> Self

Converts to this type from the input type.

impl PartialEq for F64

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

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

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 Copy for F64