Struct Bf16 

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

Methods from Deref<Target = bf16>

pub const DIGITS: u32 = 2

pub const EPSILON: bf16

pub const INFINITY: bf16

pub const MANTISSA_DIGITS: u32 = 8

pub const MAX: bf16

pub const MAX_10_EXP: i32 = 38

pub const MAX_EXP: i32 = 128

pub const MIN: bf16

pub const MIN_10_EXP: i32 = -37

pub const MIN_EXP: i32 = -125

pub const MIN_POSITIVE: bf16

pub const NAN: bf16

pub const NEG_INFINITY: bf16

pub const RADIX: u32 = 2

pub const MIN_POSITIVE_SUBNORMAL: bf16

pub const MAX_SUBNORMAL: bf16

pub const ONE: bf16

pub const ZERO: bf16

pub const NEG_ZERO: bf16

pub const NEG_ONE: bf16

pub const E: bf16

pub const PI: bf16

pub const FRAC_1_PI: bf16

pub const FRAC_1_SQRT_2: bf16

pub const FRAC_2_PI: bf16

pub const FRAC_2_SQRT_PI: bf16

pub const FRAC_PI_2: bf16

pub const FRAC_PI_3: bf16

pub const FRAC_PI_4: bf16

pub const FRAC_PI_6: bf16

pub const FRAC_PI_8: bf16

pub const LN_10: bf16

pub const LN_2: bf16

pub const LOG10_E: bf16

pub const LOG10_2: bf16

pub const LOG2_E: bf16

pub const LOG2_10: bf16

pub const SQRT_2: bf16

pub fn total_cmp(&self, other: &bf16) -> Ordering

Returns the ordering between self and other.

Unlike the standard partial comparison between floating point numbers, this comparison always produces an ordering in accordance to the totalOrder predicate as defined in the IEEE 754 (2008 revision) floating point standard. The values are ordered in the following sequence:

• negative quiet NaN
• negative signaling NaN
• negative infinity
• negative numbers
• negative subnormal numbers
• negative zero
• positive zero
• positive subnormal numbers
• positive numbers
• positive infinity
• positive signaling NaN
• positive quiet NaN.

The ordering established by this function does not always agree with the PartialOrd and PartialEq implementations of bf16. For example, they consider negative and positive zero equal, while total_cmp doesn’t.

The interpretation of the signaling NaN bit follows the definition in the IEEE 754 standard, which may not match the interpretation by some of the older, non-conformant (e.g. MIPS) hardware implementations.

Examples

let mut v: Vec<bf16> = vec![];
v.push(bf16::ONE);
v.push(bf16::INFINITY);
v.push(bf16::NEG_INFINITY);
v.push(bf16::NAN);
v.push(bf16::MAX_SUBNORMAL);
v.push(-bf16::MAX_SUBNORMAL);
v.push(bf16::ZERO);
v.push(bf16::NEG_ZERO);
v.push(bf16::NEG_ONE);
v.push(bf16::MIN_POSITIVE);

v.sort_by(|a, b| a.total_cmp(&b));

assert!(v
    .into_iter()
    .zip(
        [
            bf16::NEG_INFINITY,
            bf16::NEG_ONE,
            -bf16::MAX_SUBNORMAL,
            bf16::NEG_ZERO,
            bf16::ZERO,
            bf16::MAX_SUBNORMAL,
            bf16::MIN_POSITIVE,
            bf16::ONE,
            bf16::INFINITY,
            bf16::NAN
        ]
        .iter()
    )
    .all(|(a, b)| a.to_bits() == b.to_bits()));

Trait Implementations

impl Clone for Bf16

fn clone(&self) -> Bf16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bf16

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

Formats the value using the given formatter.

impl Deref for Bf16

type Target = bf16

The resulting type after dereferencing.

fn deref(&self) -> &<Bf16 as Deref>::Target

Dereferences the value.

impl Hash for Bf16

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

where H: Hasher,

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 Ord for Bf16

fn cmp(&self, other: &Bf16) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Bf16

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

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

impl Eq for Bf16

impl StructuralPartialEq for Bf16