Struct BFloat16 

pub struct BFloat16 { /* private fields */ }

BFloat16 — Google Brain’s 16-bit floating-point format.

Unlike IEEE fp16 (Half), bf16 shares f32’s exponent range, making it a drop-in replacement for f32 in training loops where dynamic range is more important than mantissa precision.

Implementations

impl BFloat16

pub const ZERO: Self

pub const ONE: Self

pub const NEG_ONE: Self

pub const INFINITY: Self

pub const NEG_INFINITY: Self

pub const NAN: Self

pub const MAX: Self

pub const MIN_POSITIVE: Self

pub const EPSILON: Self

pub fn from_bits(bits: u16) -> Self

Create from raw u16 bits.

pub fn to_bits(self) -> u16

Get raw u16 bits.

pub fn from_f32(value: f32) -> Self

Convert from f32 (truncation, matching hardware behavior).

pub fn to_f32(self) -> f32

Convert to f32 (lossless — just pad lower 16 bits with zeros).

pub fn is_nan(self) -> bool

Check if NaN.

pub fn is_infinite(self) -> bool

Check if infinite.

pub fn is_finite(self) -> bool

Check if finite (not NaN or infinite).

pub fn is_zero(self) -> bool

Check if zero (positive or negative).

pub fn is_sign_negative(self) -> bool

Check if the sign bit is set.

pub fn abs(self) -> Self

Absolute value.

pub fn fma(a: BFloat16, b: BFloat16, c: BFloat16) -> BFloat16

Fused multiply-add: a * b + c (computed in f32).

pub fn sqrt(self) -> Self

Square root.

pub fn recip(self) -> Self

Reciprocal (1/x).

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

Minimum of two values (NaN-propagating).

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

Maximum of two values (NaN-propagating).

pub fn clamp(self, lo: Self, hi: Self) -> Self

Clamp value to [lo, hi].

Trait Implementations

impl Add for BFloat16

type Output = BFloat16

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl Clone for BFloat16

fn clone(&self) -> BFloat16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BFloat16

impl Debug for BFloat16

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

Formats the value using the given formatter.

impl Display for BFloat16

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

Formats the value using the given formatter.

impl Div for BFloat16

type Output = BFloat16

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self

Performs the / operation.

impl Eq for BFloat16

impl From<BFloat16> for f32

fn from(v: BFloat16) -> f32

Converts to this type from the input type.

impl From<f32> for BFloat16

fn from(v: f32) -> Self

Converts to this type from the input type.

impl Hash for BFloat16

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul for BFloat16

type Output = BFloat16

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl Neg for BFloat16

type Output = BFloat16

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for BFloat16

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

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 StructuralPartialEq for BFloat16

impl Sub for BFloat16

type Output = BFloat16

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.