Struct BrainFloat16 

pub struct BrainFloat16(pub bf16);

Available on crate feature half only.

A 16-bit brain floating-point (w) number, from the set $\R$, also known as Bf16.

The range of valid numeric values is $\lbrack$bf16::MIN $\dots$ bf16::MAX$\rbrack$.

It is comprised of 1 sign bit, 8 exponent bits, and 7 significand bits.

Tuple Fields

0: bf16

Implementations

impl BrainFloat16

Constructors

pub const fn new(value: bf16) -> Self

Returns a new BrainFloat16.

Trait Implementations

impl Bound for BrainFloat16

fn is_lower_bounded(&self) -> bool

Returns true if the number is lower bounded.

fn is_upper_bounded(&self) -> bool

Returns true if the number is upper bounded.

fn lower_bound(&self) -> Option<Self>

Returns the lower bound, if any.

fn upper_bound(&self) -> Option<Self>

Returns the upper bound, if any.

impl Clone for BrainFloat16

fn clone(&self) -> BrainFloat16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstLowerBounded for BrainFloat16

const MIN: Self

The smallest value that can be represented with this type.

impl ConstNegOne for BrainFloat16

const NEG_ONE: Self

The additive inverse of the multiplicative identity, -1.

impl ConstOne for BrainFloat16

const ONE: Self

The multiplicative identity, 1.

impl ConstUpperBounded for BrainFloat16

const MAX: Self

The largest value that can be represented with this type.

impl ConstZero for BrainFloat16

const ZERO: Self

The additive identity, 0.

impl Count for BrainFloat16

fn is_countable(&self) -> bool

Returns true if the number is countable.

fn is_uncountable(&self) -> bool

Returns false if the number is countable.

impl Countable for BrainFloat16

Unimplemented.

fn next(&self) -> NumeraResult<Self>

Not implemented.

Errors

Returns NotImplemented.

fn previous(&self) -> NumeraResult<Self>

Not implemented.

Errors

Returns NotImplemented.

impl Debug for BrainFloat16

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

Formats the value using the given formatter.

impl Default for BrainFloat16

fn default() -> BrainFloat16

Returns the “default value” for a type.

impl Display for BrainFloat16

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

Formats the value using the given formatter.

impl From<&bf16> for BrainFloat16

fn from(f: &bf16) -> Self

Converts to this type from the input type.

impl From<&mut bf16> for BrainFloat16

fn from(f: &mut bf16) -> Self

Converts to this type from the input type.

impl From<bf16> for BrainFloat16

fn from(f: bf16) -> Self

Converts to this type from the input type.

impl Ident for BrainFloat16

fn can_zero(&self) -> bool

Returns true if the number can represent 0, the additive identity.

fn can_one(&self) -> bool

Returns true if the number can represent 1, the multiplicative identity.

fn can_neg_one(&self) -> bool

Returns true if the number can represent -1, the additive inverse of the multiplicative identity.

fn is_zero(&self) -> bool

Returns true if the current value is 0. the additive identity.

fn is_one(&self) -> bool

Returns true if the current value is 1, the multiplicative identity.

fn is_neg_one(&self) -> bool

Returns true if the current value is -1, the additive inverse of the multiplicative identity.

impl LowerBounded for BrainFloat16

fn new_min() -> Self

The smallest value that can be represented with this type.

impl NegOne for BrainFloat16

fn new_neg_one() -> Self

Returns a new additive inverse of the multiplicative identity, -1.

fn set_neg_one(&mut self)

where Self: Sized,

Sets this number to -1.

impl Number for BrainFloat16

fn from_inner_repr(value: Self::InnerRepr) -> NumeraResult<Self>

Returns a new BrainFloat16 from the inner representation.

Errors

This function can’t fail.

unsafe fn from_inner_repr_unchecked(value: Self::InnerRepr) -> Self

Available on crate feature not(safe) only.

Returns a new BrainFloat16 from the inner representation`.

Safety

This function is safe.

fn from_innermost_repr(value: Self::InnermostRepr) -> NumeraResult<Self>

Returns a new BrainFloat16 from the innermost representation.

Errors

This function can’t fail.

unsafe fn from_innermost_repr_unchecked(value: Self::InnermostRepr) -> Self

Available on crate feature not(safe) only.

Returns a new BrainFloat16 from the innermost representation.

Safety

This function is safe.

type InnerRepr = bf16

The inner primitive representation of the number.

type InnermostRepr = bf16

The innermost primitive representation of the number.

fn into_inner_repr(self) -> Self::InnerRepr

Deconstructs the number to its inner representation.

fn into_innermost_repr(self) -> Self::InnermostRepr

Deconstructs the number to its innermost representation.

fn try_from_inner_repr(inner: impl Into<Self::InnerRepr>) -> NumeraResult<Self>

where Self: Sized,

Forms a new number from its converted given inner representation.

impl One for BrainFloat16

fn new_one() -> Self

Returns a new multiplicative identity, 1.

fn set_one(&mut self)

where Self: Sized,

Sets this number to 1.

impl PartialEq for BrainFloat16

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

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

fn can_negative(&self) -> bool

Returns true if the type can represent negative numbers.

fn can_positive(&self) -> bool

Returns true if the type can represent positive numbers.

fn is_negative(&self) -> bool

Returns true if the value is negative (< 0).

fn is_positive(&self) -> bool

Returns true if the value is positive (> 0).

impl TryFrom<&f16> for BrainFloat16

Available on crate feature try_from only.

type Error = NumeraErrors

The type returned in the event of a conversion error.

fn try_from(f: &f16) -> NumeraResult<BrainFloat16>

Performs the conversion.

impl TryFrom<&f32> for BrainFloat16

Available on crate feature try_from only.

type Error = NumeraErrors

The type returned in the event of a conversion error.

fn try_from(f: &f32) -> NumeraResult<BrainFloat16>

Performs the conversion.

impl TryFrom<&f64> for BrainFloat16

Available on crate feature try_from only.

type Error = NumeraErrors

The type returned in the event of a conversion error.

fn try_from(f: &f64) -> NumeraResult<BrainFloat16>

Performs the conversion.

impl TryFrom<&mut f16> for BrainFloat16

Available on crate feature try_from only.

type Error = NumeraErrors

The type returned in the event of a conversion error.

fn try_from(f: &mut f16) -> NumeraResult<BrainFloat16>

Performs the conversion.

impl TryFrom<&mut f32> for BrainFloat16

Available on crate feature try_from only.

type Error = NumeraErrors

The type returned in the event of a conversion error.

fn try_from(f: &mut f32) -> NumeraResult<BrainFloat16>

Performs the conversion.

impl TryFrom<&mut f64> for BrainFloat16

Available on crate feature try_from only.

type Error = NumeraErrors

The type returned in the event of a conversion error.

fn try_from(f: &mut f64) -> NumeraResult<BrainFloat16>

Performs the conversion.

impl TryFrom<f16> for BrainFloat16

Available on crate feature try_from only.

type Error = NumeraErrors

The type returned in the event of a conversion error.

fn try_from(f: f16) -> NumeraResult<BrainFloat16>

Performs the conversion.

impl TryFrom<f32> for BrainFloat16

Available on crate feature try_from only.

type Error = NumeraErrors

The type returned in the event of a conversion error.

fn try_from(f: f32) -> NumeraResult<BrainFloat16>

Performs the conversion.

impl TryFrom<f64> for BrainFloat16

Available on crate feature try_from only.

type Error = NumeraErrors

The type returned in the event of a conversion error.

fn try_from(f: f64) -> NumeraResult<BrainFloat16>

Performs the conversion.

impl UpperBounded for BrainFloat16

fn new_max() -> Self

The largest value that can be represented with this type.

impl Zero for BrainFloat16

fn new_zero() -> Self

Returns a new additive identity, 0.

fn set_zero(&mut self)

where Self: Sized,

Sets this number to 0.

impl Copy for BrainFloat16

impl Negative for BrainFloat16

impl Positive for BrainFloat16

impl StructuralPartialEq for BrainFloat16