Struct bf16

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

A 16-bit floating point type implementing the bfloat16 format.

The bfloat16 floating point format is a truncated 16-bit version of the IEEE 754 standard binary32, a.k.a f32. bf16 has approximately the same dynamic range as f32 by having a lower precision than struct@f16. While struct@f16 has a precision of 11 bits, bf16 has a precision of only 8 bits.

Implementations

impl bf16

pub const DIGITS: u32 = 2u32

Approximate number of bf16 significant digits in base 10

pub const EPSILON: bf16

bf16 machine epsilon value

This is the difference between 1.0 and the next largest representable number.

pub const INFINITY: bf16

bf16 positive Infinity (+∞)

pub const MANTISSA_DIGITS: u32 = 8u32

Number of bf16 significant digits in base 2

pub const MAX: bf16

Largest finite bf16 value

pub const MAX_10_EXP: i32 = 38i32

Maximum possible bf16 power of 10 exponent

pub const MAX_EXP: i32 = 128i32

Maximum possible bf16 power of 2 exponent

pub const MIN: bf16

Smallest finite bf16 value

pub const MIN_10_EXP: i32 = -37i32

Minimum possible normal bf16 power of 10 exponent

pub const MIN_EXP: i32 = -125i32

One greater than the minimum possible normal bf16 power of 2 exponent

pub const MIN_POSITIVE: bf16

Smallest positive normal bf16 value

pub const NAN: bf16

bf16 Not a Number (NaN)

pub const NEG_INFINITY: bf16

bf16 negative infinity (-∞).

pub const RADIX: u32 = 2u32

The radix or base of the internal representation of bf16

pub const MIN_POSITIVE_SUBNORMAL: bf16

Minimum positive subnormal bf16 value

pub const MAX_SUBNORMAL: bf16

Maximum subnormal bf16 value

pub const ONE: bf16

bf16 1

pub const ZERO: bf16

bf16 0

pub const NEG_ZERO: bf16

bf16 -0

pub const NEG_ONE: bf16

bf16 -1

pub const E: bf16

bf16 Euler’s number (ℯ)

pub const PI: bf16

bf16 Archimedes’ constant (π)

pub const FRAC_1_PI: bf16

bf16 1/π

pub const FRAC_1_SQRT_2: bf16

bf16 1/√2

pub const FRAC_2_PI: bf16

bf16 2/π

pub const FRAC_2_SQRT_PI: bf16

bf16 2/√π

pub const FRAC_PI_2: bf16

bf16 π/2

pub const FRAC_PI_3: bf16

bf16 π/3

pub const FRAC_PI_4: bf16

bf16 π/4

pub const FRAC_PI_6: bf16

bf16 π/6

pub const FRAC_PI_8: bf16

bf16 π/8

pub const LN_10: bf16

bf16 𝗅𝗇 10

pub const LN_2: bf16

bf16 𝗅𝗇 2

pub const LOG10_E: bf16

bf16 𝗅𝗈𝗀₁₀ℯ

pub const LOG10_2: bf16

bf16 𝗅𝗈𝗀₁₀2

pub const LOG2_E: bf16

bf16 𝗅𝗈𝗀₂ℯ

pub const LOG2_10: bf16

bf16 𝗅𝗈𝗀₂10

pub const SQRT_2: bf16

bf16 √2

pub const fn from_bits(bits: u16) -> bf16

Constructs a bf16 value from the raw bits.

pub fn from_f32(value: f32) -> bf16

Constructs a bf16 value from a 32-bit floating point value.

This operation is lossy. If the 32-bit value is too large to fit, ±∞ will result. NaN values are preserved. Subnormal values that are too tiny to be represented will result in ±0. All other values are truncated and rounded to the nearest representable value.

pub const fn from_f32_const(value: f32) -> bf16

Constructs a bf16 value from a 32-bit floating point value.

This function is identical to from_f32 except it never uses hardware intrinsics, which allows it to be const. from_f32 should be preferred in any non-const context.

This operation is lossy. If the 32-bit value is too large to fit, ±∞ will result. NaN values are preserved. Subnormal values that are too tiny to be represented will result in ±0. All other values are truncated and rounded to the nearest representable value.

pub fn from_f64(value: f64) -> bf16

Constructs a bf16 value from a 64-bit floating point value.

This operation is lossy. If the 64-bit value is to large to fit, ±∞ will result. NaN values are preserved. 64-bit subnormal values are too tiny to be represented and result in ±0. Exponents that underflow the minimum exponent will result in subnormals or ±0. All other values are truncated and rounded to the nearest representable value.

pub const fn from_f64_const(value: f64) -> bf16

Constructs a bf16 value from a 64-bit floating point value.

This function is identical to from_f64 except it never uses hardware intrinsics, which allows it to be const. from_f64 should be preferred in any non-const context.

This operation is lossy. If the 64-bit value is to large to fit, ±∞ will result. NaN values are preserved. 64-bit subnormal values are too tiny to be represented and result in ±0. Exponents that underflow the minimum exponent will result in subnormals or ±0. All other values are truncated and rounded to the nearest representable value.

pub const fn to_bits(self) -> u16

Converts a bf16 into the underlying bit representation.

pub const fn to_le_bytes(self) -> [u8; 2]

Returns the memory representation of the underlying bit representation as a byte array in little-endian byte order.

Examples

let bytes = bf16::from_f32(12.5).to_le_bytes();
assert_eq!(bytes, [0x48, 0x41]);

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

Returns the memory representation of the underlying bit representation as a byte array in big-endian (network) byte order.

Examples

let bytes = bf16::from_f32(12.5).to_be_bytes();
assert_eq!(bytes, [0x41, 0x48]);

pub const fn to_ne_bytes(self) -> [u8; 2]

Returns the memory representation of the underlying bit representation as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

Examples

let bytes = bf16::from_f32(12.5).to_ne_bytes();
assert_eq!(bytes, if cfg!(target_endian = "big") {
    [0x41, 0x48]
} else {
    [0x48, 0x41]
});

pub const fn from_le_bytes(bytes: [u8; 2]) -> bf16

Creates a floating point value from its representation as a byte array in little endian.

Examples

let value = bf16::from_le_bytes([0x48, 0x41]);
assert_eq!(value, bf16::from_f32(12.5));

pub const fn from_be_bytes(bytes: [u8; 2]) -> bf16

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

Examples

let value = bf16::from_be_bytes([0x41, 0x48]);
assert_eq!(value, bf16::from_f32(12.5));

pub const fn from_ne_bytes(bytes: [u8; 2]) -> bf16

Creates a floating point value from its representation as a byte array in native endian.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

Examples

let value = bf16::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x41, 0x48]
} else {
    [0x48, 0x41]
});
assert_eq!(value, bf16::from_f32(12.5));

pub fn to_f32(self) -> f32

Converts a bf16 value into an f32 value.

This conversion is lossless as all values can be represented exactly in f32.

pub const fn to_f32_const(self) -> f32

Converts a bf16 value into an f32 value.

This function is identical to to_f32 except it never uses hardware intrinsics, which allows it to be const. to_f32 should be preferred in any non-const context.

This conversion is lossless as all values can be represented exactly in f32.

pub fn to_f64(self) -> f64

Converts a bf16 value into an f64 value.

This conversion is lossless as all values can be represented exactly in f64.

pub const fn to_f64_const(self) -> f64

Converts a bf16 value into an f64 value.

This function is identical to to_f64 except it never uses hardware intrinsics, which allows it to be const. to_f64 should be preferred in any non-const context.

This conversion is lossless as all values can be represented exactly in f64.

pub const fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

Examples

let nan = bf16::NAN;
let f = bf16::from_f32(7.0_f32);

assert!(nan.is_nan());
assert!(!f.is_nan());

pub const fn is_infinite(self) -> bool

Returns true if this value is ±∞ and false otherwise.

Examples

let f = bf16::from_f32(7.0f32);
let inf = bf16::INFINITY;
let neg_inf = bf16::NEG_INFINITY;
let nan = bf16::NAN;

assert!(!f.is_infinite());
assert!(!nan.is_infinite());

assert!(inf.is_infinite());
assert!(neg_inf.is_infinite());

pub const fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

Examples

let f = bf16::from_f32(7.0f32);
let inf = bf16::INFINITY;
let neg_inf = bf16::NEG_INFINITY;
let nan = bf16::NAN;

assert!(f.is_finite());

assert!(!nan.is_finite());
assert!(!inf.is_finite());
assert!(!neg_inf.is_finite());

pub const fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal, or NaN.

Examples

let min = bf16::MIN_POSITIVE;
let max = bf16::MAX;
let lower_than_min = bf16::from_f32(1.0e-39_f32);
let zero = bf16::from_f32(0.0_f32);

assert!(min.is_normal());
assert!(max.is_normal());

assert!(!zero.is_normal());
assert!(!bf16::NAN.is_normal());
assert!(!bf16::INFINITY.is_normal());
// Values between 0 and `min` are subnormal.
assert!(!lower_than_min.is_normal());

pub const fn classify(self) -> FpCategory

Returns the floating point category of the number.

If only one property is going to be tested, it is generally faster to use the specific predicate instead.

Examples

use std::num::FpCategory;

let num = bf16::from_f32(12.4_f32);
let inf = bf16::INFINITY;

assert_eq!(num.classify(), FpCategory::Normal);
assert_eq!(inf.classify(), FpCategory::Infinite);

pub const fn signum(self) -> bf16

Returns a number that represents the sign of self.

• 1.0 if the number is positive, +0.0 or INFINITY
• −1.0 if the number is negative, −0.0 or [NEG_INFINITY`]bf16::NEG_INFINITY
• NAN if the number is NaN

Examples

let f = bf16::from_f32(3.5_f32);

assert_eq!(f.signum(), bf16::from_f32(1.0));
assert_eq!(bf16::NEG_INFINITY.signum(), bf16::from_f32(-1.0));

assert!(bf16::NAN.signum().is_nan());

pub const fn is_sign_positive(self) -> bool

Returns true if and only if self has a positive sign, including +0.0, NaNs with a positive sign bit and +∞.

Examples

let nan = bf16::NAN;
let f = bf16::from_f32(7.0_f32);
let g = bf16::from_f32(-7.0_f32);

assert!(f.is_sign_positive());
assert!(!g.is_sign_positive());
// NaN can be either positive or negative
assert!(nan.is_sign_positive() != nan.is_sign_negative());

pub const fn is_sign_negative(self) -> bool

Returns true if and only if self has a negative sign, including −0.0, NaNs with a negative sign bit and −∞.

Examples

let nan = bf16::NAN;
let f = bf16::from_f32(7.0f32);
let g = bf16::from_f32(-7.0f32);

assert!(!f.is_sign_negative());
assert!(g.is_sign_negative());
// NaN can be either positive or negative
assert!(nan.is_sign_positive() != nan.is_sign_negative());

pub const fn copysign(self, sign: bf16) -> bf16

Returns a number composed of the magnitude of self and the sign of sign.

Equal to self if the sign of self and sign are the same, otherwise equal to -self. If self is NaN, then NaN with the sign of sign is returned.

Examples

let f = bf16::from_f32(3.5);

assert_eq!(f.copysign(bf16::from_f32(0.42)), bf16::from_f32(3.5));
assert_eq!(f.copysign(bf16::from_f32(-0.42)), bf16::from_f32(-3.5));
assert_eq!((-f).copysign(bf16::from_f32(0.42)), bf16::from_f32(3.5));
assert_eq!((-f).copysign(bf16::from_f32(-0.42)), bf16::from_f32(-3.5));

assert!(bf16::NAN.copysign(bf16::from_f32(1.0)).is_nan());

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

Returns the maximum of the two numbers.

If one of the arguments is NaN, then the other argument is returned.

Examples

let x = bf16::from_f32(1.0);
let y = bf16::from_f32(2.0);

assert_eq!(x.max(y), y);

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

Returns the minimum of the two numbers.

If one of the arguments is NaN, then the other argument is returned.

Examples

let x = bf16::from_f32(1.0);
let y = bf16::from_f32(2.0);

assert_eq!(x.min(y), x);

pub fn clamp(self, min: bf16, max: bf16) -> bf16

Restrict a value to a certain interval unless it is NaN.

Returns max if self is greater than max, and min if self is less than min. Otherwise this returns self.

Note that this function returns NaN if the initial value was NaN as well.

Panics

Panics if min > max, min is NaN, or max is NaN.

Examples

assert!(bf16::from_f32(-3.0).clamp(bf16::from_f32(-2.0), bf16::from_f32(1.0)) == bf16::from_f32(-2.0));
assert!(bf16::from_f32(0.0).clamp(bf16::from_f32(-2.0), bf16::from_f32(1.0)) == bf16::from_f32(0.0));
assert!(bf16::from_f32(2.0).clamp(bf16::from_f32(-2.0), bf16::from_f32(1.0)) == bf16::from_f32(1.0));
assert!(bf16::NAN.clamp(bf16::from_f32(-2.0), bf16::from_f32(1.0)).is_nan());

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()));

pub fn serialize_as_f32<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Alternate serialize adapter for serializing as a float.

By default, bf16 serializes as a newtype of u16. This is an alternate serialize implementation that serializes as an f32 value. It is designed for use with serialize_with serde attributes. Deserialization from f32 values is already supported by the default deserialize implementation.

Examples

A demonstration on how to use this adapater:

use serde::{Serialize, Deserialize};
use half::bf16;

#[derive(Serialize, Deserialize)]
struct MyStruct {
    #[serde(serialize_with = "bf16::serialize_as_f32")]
    value: bf16 // Will be serialized as f32 instead of u16
}

pub fn serialize_as_string<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Alternate serialize adapter for serializing as a string.

By default, bf16 serializes as a newtype of u16. This is an alternate serialize implementation that serializes as a string value. It is designed for use with serialize_with serde attributes. Deserialization from string values is already supported by the default deserialize implementation.

Examples

A demonstration on how to use this adapater:

use serde::{Serialize, Deserialize};
use half::bf16;

#[derive(Serialize, Deserialize)]
struct MyStruct {
    #[serde(serialize_with = "bf16::serialize_as_string")]
    value: bf16 // Will be serialized as a string instead of u16
}

Trait Implementations

impl Abs for bf16

fn abs(x: Self) -> Self

fn __expand_abs( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl Add<&bf16> for &bf16

type Output = <bf16 as Add>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &bf16) -> <&bf16 as Add<&bf16>>::Output

Performs the + operation.

impl Add<&bf16> for bf16

type Output = <bf16 as Add>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &bf16) -> <bf16 as Add<&bf16>>::Output

Performs the + operation.

impl Add<bf16> for &bf16

type Output = <bf16 as Add>::Output

The resulting type after applying the + operator.

fn add(self, rhs: bf16) -> <&bf16 as Add<bf16>>::Output

Performs the + operation.

impl Add for bf16

type Output = bf16

The resulting type after applying the + operator.

fn add(self, rhs: bf16) -> <bf16 as Add>::Output

Performs the + operation.

impl AddAssign<&bf16> for bf16

fn add_assign(&mut self, rhs: &bf16)

Performs the += operation.

impl AddAssign for bf16

fn add_assign(&mut self, rhs: bf16)

Performs the += operation.

impl AsPrimitive<bf16> for bf16

fn as_(self) -> bf16

Convert a value to another, using the as operator.

impl AsPrimitive<bf16> for f16

fn as_(self) -> bf16

Convert a value to another, using the as operator.

impl AsPrimitive<bf16> for u32

fn as_(self) -> bf16

Convert a value to another, using the as operator.

impl AsPrimitive<f16> for bf16

fn as_(self) -> f16

Convert a value to another, using the as operator.

impl AsPrimitive<f32> for bf16

fn as_(self) -> f32

Convert a value to another, using the as operator.

impl AsPrimitive<f64> for bf16

fn as_(self) -> f64

Convert a value to another, using the as operator.

impl AsPrimitive<i16> for bf16

fn as_(self) -> i16

Convert a value to another, using the as operator.

impl AsPrimitive<i32> for bf16

fn as_(self) -> i32

Convert a value to another, using the as operator.

impl AsPrimitive<i64> for bf16

fn as_(self) -> i64

Convert a value to another, using the as operator.

impl AsPrimitive<i8> for bf16

fn as_(self) -> i8

Convert a value to another, using the as operator.

impl AsPrimitive<isize> for bf16

fn as_(self) -> isize

Convert a value to another, using the as operator.

impl AsPrimitive<u16> for bf16

fn as_(self) -> u16

Convert a value to another, using the as operator.

impl AsPrimitive<u32> for bf16

fn as_(self) -> u32

Convert a value to another, using the as operator.

impl AsPrimitive<u64> for bf16

fn as_(self) -> u64

Convert a value to another, using the as operator.

impl AsPrimitive<u8> for bf16

fn as_(self) -> u8

Convert a value to another, using the as operator.

impl AsPrimitive<usize> for bf16

fn as_(self) -> usize

Convert a value to another, using the as operator.

impl<B> AutodiffModule<B> for bf16

where B: AutodiffBackend,

type InnerModule = bf16

Inner module without auto-differentiation.

fn valid(&self) -> <bf16 as AutodiffModule<B>>::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl Binary for bf16

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

Formats the value using the given formatter.

impl Bounded for bf16

fn min_value() -> bf16

Returns the smallest finite number this type can represent

fn max_value() -> bf16

Returns the largest finite number this type can represent

impl Ceil for bf16

fn ceil(x: Self) -> Self

fn __expand_ceil( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl Clamp for bf16

fn clamp(input: Self, min_value: Self, max_value: Self) -> Self

Clamp the input value between the max and min values provided.

fn __expand_clamp( scope: &mut Scope, input: Self::ExpandType, min_value: Self::ExpandType, max_value: Self::ExpandType, ) -> Self::ExpandType

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 Cos for bf16

fn cos(x: Self) -> Self

fn __expand_cos( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl CubeElement for bf16

fn type_name() -> &'static str

Returns the name of the type.

fn as_bytes(slice: &[bf16]) -> &[u8]

Convert a slice of elements to a slice of bytes.

fn from_bytes(bytes: &[u8]) -> &[bf16]

Convert a slice of bytes to a slice of elements.

fn cube_type() -> StorageType

Element representation for cubecl.

fn maximum_value() -> bf16

Highest possible value

fn minimum_value() -> bf16

Lowest possible value

impl CubePrimitive for bf16

fn as_type_native() -> Option<StorageType>

Return the element type to use on GPU

fn from_const_value(value: ConstantScalarValue) -> bf16

fn as_type(_scope: &Scope) -> StorageType

Return the element type to use on GPU.

fn as_type_native_unchecked() -> StorageType

Native or static element type.

fn size() -> Option<usize>

Only native element types have a size.

fn size_bits() -> Option<usize>

Only native element types have a size.

fn size_bits_unchecked() -> usize

Only native element types have a size.

fn from_expand_elem(elem: ExpandElement) -> Self::ExpandType

fn into_lit_unchecked(self) -> Self

fn supported_uses<S>(client: &ComputeClient<S>) -> EnumSet<TypeUsage>

where S: ComputeServer,

fn elem_size() -> u32

fn elem_size_bits() -> u32

fn packing_factor() -> u32

fn __expand_elem_size(scope: &Scope) -> u32

fn __expand_elem_size_bits(scope: &Scope) -> u32

fn __expand_packing_factor(scope: &Scope) -> u32

impl CubeType for bf16

type ExpandType = ExpandElementTyped<bf16>

fn into_mut(scope: &mut Scope, expand: Self::ExpandType) -> Self::ExpandType

Wrapper around the init method, necessary to type inference.

impl Debug for bf16

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

Formats the value using the given formatter.

impl Default for bf16

fn default() -> bf16

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for bf16

fn deserialize<D>( deserializer: D, ) -> Result<bf16, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for bf16

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

Formats the value using the given formatter.

impl Div<&bf16> for &bf16

type Output = <bf16 as Div>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &bf16) -> <&bf16 as Div<&bf16>>::Output

Performs the / operation.

impl Div<&bf16> for bf16

type Output = <bf16 as Div>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &bf16) -> <bf16 as Div<&bf16>>::Output

Performs the / operation.

impl Div<bf16> for &bf16

type Output = <bf16 as Div>::Output

The resulting type after applying the / operator.

fn div(self, rhs: bf16) -> <&bf16 as Div<bf16>>::Output

Performs the / operation.

impl Div for bf16

type Output = bf16

The resulting type after applying the / operator.

fn div(self, rhs: bf16) -> <bf16 as Div>::Output

Performs the / operation.

impl DivAssign<&bf16> for bf16

fn div_assign(&mut self, rhs: &bf16)

Performs the /= operation.

impl DivAssign for bf16

fn div_assign(&mut self, rhs: bf16)

Performs the /= operation.

impl Dot for bf16

fn dot(self, _rhs: Self) -> Self

fn __expand_dot( scope: &mut Scope, lhs: ExpandElementTyped<Self>, rhs: ExpandElementTyped<Self>, ) -> ExpandElementTyped<Self>

impl Element for bf16

fn dtype() -> DType

The dtype of the element.

impl ElementComparison for bf16

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

Returns and Ordering between self and other.

impl ElementConversion for bf16

fn from_elem<E>(elem: E) -> bf16

where E: ToElement,

Converts an element to another element.

fn elem<E>(self) -> E

where E: Element,

Converts and returns the converted element.

impl ElementLimits for bf16

const MIN: bf16 = bf16::MIN

The minimum representable value

const MAX: bf16 = bf16::MAX

The maximum representable value

impl ElementRandom for bf16

fn random<R>(distribution: Distribution, rng: &mut R) -> bf16

where R: RngCore,

Returns a random value for the given distribution.

impl Erf for bf16

fn erf(x: Self) -> Self

fn __expand_erf( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl Exp for bf16

fn exp(x: Self) -> Self

fn __expand_exp( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl ExpandElementIntoMut for bf16

fn elem_into_mut(scope: &mut Scope, elem: ExpandElement) -> ExpandElement

impl Float for bf16

fn nan() -> bf16

Returns the NaN value.

fn infinity() -> bf16

Returns the infinite value.

fn neg_infinity() -> bf16

Returns the negative infinite value.

fn neg_zero() -> bf16

Returns -0.0.

fn min_value() -> bf16

Returns the smallest finite value that this type can represent.

fn min_positive_value() -> bf16

Returns the smallest positive, normalized value that this type can represent.

fn epsilon() -> bf16

Returns epsilon, a small positive value.

fn max_value() -> bf16

Returns the largest finite value that this type can represent.

fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

fn is_infinite(self) -> bool

Returns true if this value is positive infinity or negative infinity and false otherwise.

fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal, or NaN.

fn classify(self) -> FpCategory

Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead.

fn floor(self) -> bf16

Returns the largest integer less than or equal to a number.

fn ceil(self) -> bf16

Returns the smallest integer greater than or equal to a number.

fn round(self) -> bf16

Returns the nearest integer to a number. Round half-way cases away from 0.0.

fn trunc(self) -> bf16

Return the integer part of a number.

fn fract(self) -> bf16

Returns the fractional part of a number.

fn abs(self) -> bf16

Computes the absolute value of self. Returns Float::nan() if the number is Float::nan().

fn signum(self) -> bf16

Returns a number that represents the sign of self.

fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0, Float::infinity(), and Float::nan().

fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0, Float::neg_infinity(), and -Float::nan().

fn mul_add(self, a: bf16, b: bf16) -> bf16

Fused multiply-add. Computes (self * a) + b with only one rounding error, yielding a more accurate result than an unfused multiply-add.

fn recip(self) -> bf16

Take the reciprocal (inverse) of a number, 1/x.

fn powi(self, n: i32) -> bf16

Raise a number to an integer power.

fn powf(self, n: bf16) -> bf16

Raise a number to a floating point power.

fn sqrt(self) -> bf16

Take the square root of a number.

fn exp(self) -> bf16

Returns e^(self), (the exponential function).

fn exp2(self) -> bf16

Returns 2^(self).

fn ln(self) -> bf16

Returns the natural logarithm of the number.

fn log(self, base: bf16) -> bf16

Returns the logarithm of the number with respect to an arbitrary base.

fn log2(self) -> bf16

Returns the base 2 logarithm of the number.

fn log10(self) -> bf16

Returns the base 10 logarithm of the number.

fn to_degrees(self) -> bf16

Converts radians to degrees.

fn to_radians(self) -> bf16

Converts degrees to radians.

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

Returns the maximum of the two numbers.

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

Returns the minimum of the two numbers.

fn abs_sub(self, other: bf16) -> bf16

The positive difference of two numbers.

fn cbrt(self) -> bf16

Take the cubic root of a number.

fn hypot(self, other: bf16) -> bf16

Calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y.

fn sin(self) -> bf16

Computes the sine of a number (in radians).

fn cos(self) -> bf16

Computes the cosine of a number (in radians).

fn tan(self) -> bf16

Computes the tangent of a number (in radians).

fn asin(self) -> bf16

Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1].

fn acos(self) -> bf16

Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1].

fn atan(self) -> bf16

Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2];

fn atan2(self, other: bf16) -> bf16

Computes the four quadrant arctangent of self (y) and other (x).

fn sin_cos(self) -> (bf16, bf16)

Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)).

fn exp_m1(self) -> bf16

Returns e^(self) - 1 in a way that is accurate even if the number is close to zero.

fn ln_1p(self) -> bf16

Returns ln(1+n) (natural logarithm) more accurately than if the operations were performed separately.

fn sinh(self) -> bf16

Hyperbolic sine function.

fn cosh(self) -> bf16

Hyperbolic cosine function.

fn tanh(self) -> bf16

Hyperbolic tangent function.

fn asinh(self) -> bf16

Inverse hyperbolic sine function.

fn acosh(self) -> bf16

Inverse hyperbolic cosine function.

fn atanh(self) -> bf16

Inverse hyperbolic tangent function.

fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

fn is_subnormal(self) -> bool

Returns true if the number is subnormal.

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

Clamps a value between a min and max.

fn copysign(self, sign: Self) -> Self

Returns a number composed of the magnitude of self and the sign of sign.

impl Float for bf16

const DIGITS: u32 = 2u32

const EPSILON: bf16 = bf16::EPSILON

const INFINITY: bf16 = bf16::INFINITY

const MANTISSA_DIGITS: u32 = 8u32

const MAX_10_EXP: i32 = 38i32

const MAX_EXP: i32 = 128i32

const MIN_10_EXP: i32 = -37i32

const MIN_EXP: i32 = -125i32

const MIN_POSITIVE: bf16 = bf16::MIN_POSITIVE

const NAN: bf16 = bf16::NAN

const NEG_INFINITY: bf16 = bf16::NEG_INFINITY

const RADIX: u32 = 2u32

fn new(val: f32) -> bf16

fn __expand_new(scope: &mut Scope, val: f32) -> Self::ExpandType

impl FloatConst for bf16

fn E() -> bf16

Return Euler’s number.

fn FRAC_1_PI() -> bf16

Return 1.0 / π.

fn FRAC_1_SQRT_2() -> bf16

Return 1.0 / sqrt(2.0).

fn FRAC_2_PI() -> bf16

Return 2.0 / π.

fn FRAC_2_SQRT_PI() -> bf16

Return 2.0 / sqrt(π).

fn FRAC_PI_2() -> bf16

Return π / 2.0.

fn FRAC_PI_3() -> bf16

Return π / 3.0.

fn FRAC_PI_4() -> bf16

Return π / 4.0.

fn FRAC_PI_6() -> bf16

Return π / 6.0.

fn FRAC_PI_8() -> bf16

Return π / 8.0.

fn LN_10() -> bf16

Return ln(10.0).

fn LN_2() -> bf16

Return ln(2.0).

fn LOG10_E() -> bf16

Return log10(e).

fn LOG2_E() -> bf16

Return log2(e).

fn PI() -> bf16

Return Archimedes’ constant π.

fn SQRT_2() -> bf16

Return sqrt(2.0).

fn LOG10_2() -> bf16

where bf16: Sized + Div<Output = bf16>,

Return log10(2.0).

fn LOG2_10() -> bf16

where bf16: Sized + Div<Output = bf16>,

Return log2(10.0).

fn TAU() -> Self

where Self: Sized + Add<Output = Self>,

Return the full circle constant τ.

impl FloatCore for bf16

fn infinity() -> bf16

Returns positive infinity.

fn neg_infinity() -> bf16

Returns negative infinity.

fn nan() -> bf16

Returns NaN.

fn neg_zero() -> bf16

Returns -0.0.

fn min_value() -> bf16

Returns the smallest finite value that this type can represent.

fn min_positive_value() -> bf16

Returns the smallest positive, normalized value that this type can represent.

fn epsilon() -> bf16

Returns epsilon, a small positive value.

fn max_value() -> bf16

Returns the largest finite value that this type can represent.

fn is_nan(self) -> bool

Returns true if the number is NaN.

fn is_infinite(self) -> bool

Returns true if the number is infinite.

fn is_finite(self) -> bool

Returns true if the number is neither infinite or NaN.

fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal or NaN.

fn classify(self) -> FpCategory

Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead.

fn floor(self) -> bf16

Returns the largest integer less than or equal to a number.

fn ceil(self) -> bf16

Returns the smallest integer greater than or equal to a number.

fn round(self) -> bf16

Returns the nearest integer to a number. Round half-way cases away from 0.0.

fn trunc(self) -> bf16

Return the integer part of a number.

fn fract(self) -> bf16

Returns the fractional part of a number.

fn abs(self) -> bf16

Computes the absolute value of self. Returns FloatCore::nan() if the number is FloatCore::nan().

fn signum(self) -> bf16

Returns a number that represents the sign of self.

fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0 and FloatCore::infinity(), and FloatCore::nan().

fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0 and FloatCore::neg_infinity(), and -FloatCore::nan().

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

Returns the minimum of the two numbers.

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

Returns the maximum of the two numbers.

fn recip(self) -> bf16

Returns the reciprocal (multiplicative inverse) of the number.

fn powi(self, exp: i32) -> bf16

Raise a number to an integer power.

fn to_degrees(self) -> bf16

Converts to degrees, assuming the number is in radians.

fn to_radians(self) -> bf16

Converts to radians, assuming the number is in degrees.

fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

fn is_subnormal(self) -> bool

Returns true if the number is subnormal.

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

A value bounded by a minimum and a maximum

impl Floor for bf16

fn floor(x: Self) -> Self

fn __expand_floor( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl From<bf16> for ExpandElement

fn from(value: bf16) -> ExpandElement

Converts to this type from the input type.

impl From<bf16> for ExpandElementTyped<bf16>

fn from(value: bf16) -> ExpandElementTyped<bf16>

Converts to this type from the input type.

impl From<bf16> for Variable

fn from(value: bf16) -> Variable

Converts to this type from the input type.

impl From<bf16> for f32

fn from(x: bf16) -> f32

Converts to this type from the input type.

impl From<bf16> for f64

fn from(x: bf16) -> f64

Converts to this type from the input type.

impl From<i8> for bf16

fn from(x: i8) -> bf16

Converts to this type from the input type.

impl From<u8> for bf16

fn from(x: u8) -> bf16

Converts to this type from the input type.

impl FromBytes for bf16

where u16: FromBytes,

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &Self with a DST length equal to count.

fn ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the prefix of the given source as a DST &Self with length equal to count.

fn ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the suffix of the given source as a DST &Self with length equal to count.

fn mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &mut Self with a DST length equal to count.

fn mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the prefix of the given source as a &mut Self with DST length equal to count.

fn mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the suffix of the given source as a &mut Self with DST length equal to count.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromBytes for bf16

type Bytes = [u8; 2]

fn from_be_bytes(bytes: &<bf16 as FromBytes>::Bytes) -> bf16

Create a number from its representation as a byte array in big endian.

fn from_le_bytes(bytes: &<bf16 as FromBytes>::Bytes) -> bf16

Create a number from its representation as a byte array in little endian.

fn from_ne_bytes(bytes: &<bf16 as FromBytes>::Bytes) -> bf16

Create a number from its memory representation as a byte array in native endianness.

impl FromPrimitive for bf16

fn from_i64(n: i64) -> Option<bf16>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<bf16>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<bf16>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<bf16>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<bf16>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<bf16>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<bf16>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<bf16>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<bf16>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<bf16>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl FromStr for bf16

type Err = ParseFloatError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<bf16, ParseFloatError>

Parses a string s to return a value of this type.

impl FromZeros for bf16

where u16: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl IntoBytes for bf16

where u16: IntoBytes,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl IntoMut for bf16

fn into_mut(self, _scope: &mut Scope) -> bf16

impl IntoRuntime for bf16

fn __expand_runtime_method(self, scope: &mut Scope) -> ExpandElementTyped<bf16>

fn runtime(self) -> Self

impl IsInf for bf16

fn is_inf(x: Self) -> bool

fn __expand_is_inf( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<bool>

impl IsNan for bf16

fn is_nan(x: Self) -> bool

fn __expand_is_nan( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<bool>

impl KnownLayout for bf16

where bf16: Sized,

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

fn size_for_metadata(meta: Self::PointerMetadata) -> Option<usize>

Computes the size of an object of type Self with the given pointer metadata.

impl Log for bf16

fn log(x: Self) -> Self

fn __expand_log( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl Log1p for bf16

fn log1p(x: Self) -> Self

fn __expand_log1p( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl LowerExp for bf16

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

Formats the value using the given formatter.

impl LowerHex for bf16

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

Formats the value using the given formatter.

impl Magnitude for bf16

fn magnitude(x: Self) -> Self

fn __expand_magnitude( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl MatmulPrecision for bf16

type Lhs = (bf16, bf16)

Element type of lhs input tensor of the kernel.

type Rhs = (bf16, bf16)

Element type of rhs input tensor of the kernel.

type Acc = (bf16, f32)

Element type of acc input tensor of the kernel.

impl Max for bf16

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

fn __expand_max( scope: &mut Scope, lhs: ExpandElementTyped<Self>, rhs: ExpandElementTyped<Self>, ) -> ExpandElementTyped<Self>

impl Min for bf16

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

fn __expand_min( scope: &mut Scope, lhs: ExpandElementTyped<Self>, rhs: ExpandElementTyped<Self>, ) -> ExpandElementTyped<Self>

impl<B> Module<B> for bf16

where B: Backend,

type Record = ConstantRecord

Type to save and load the module.

fn visit<V>(&self, _visitor: &mut V)

where V: ModuleVisitor<B>,

Visit each tensor parameter in the module with a visitor.

fn map<M>(self, _mapper: &mut M) -> bf16

where M: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.

fn load_record(self, _record: <bf16 as Module<B>>::Record) -> bf16

Load the module state from a record.

fn into_record(self) -> <bf16 as Module<B>>::Record

Convert the module into a record containing the state.

fn to_device(self, _: &<B as Backend>::Device) -> bf16

Move the module and all of its sub-modules to the given device.

fn fork(self, _: &<B as Backend>::Device) -> bf16

Fork the module and all of its sub-modules to the given device.

fn collect_devices( &self, devices: Vec<<B as Backend>::Device>, ) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn devices(&self) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree without duplicates.

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Save the module to a file using the provided file recorder.

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder.

fn quantize_weights(self, quantizer: &mut Quantizer) -> Self

Quantize the weights of the module.

impl ModuleDisplay for bf16

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings.

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module.

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module.

impl ModuleDisplayDefault for bf16

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes.

fn num_params(&self) -> usize

Gets the number of the parameters of the module.

impl Mul<&bf16> for &bf16

type Output = <bf16 as Mul>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &bf16) -> <&bf16 as Mul<&bf16>>::Output

Performs the * operation.

impl Mul<&bf16> for bf16

type Output = <bf16 as Mul>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &bf16) -> <bf16 as Mul<&bf16>>::Output

Performs the * operation.

impl Mul<bf16> for &bf16

type Output = <bf16 as Mul>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: bf16) -> <&bf16 as Mul<bf16>>::Output

Performs the * operation.

impl Mul for bf16

type Output = bf16

The resulting type after applying the * operator.

fn mul(self, rhs: bf16) -> <bf16 as Mul>::Output

Performs the * operation.

impl MulAssign<&bf16> for bf16

fn mul_assign(&mut self, rhs: &bf16)

Performs the *= operation.

impl MulAssign for bf16

fn mul_assign(&mut self, rhs: bf16)

Performs the *= operation.

impl Neg for &bf16

type Output = <bf16 as Neg>::Output

The resulting type after applying the - operator.

fn neg(self) -> <&bf16 as Neg>::Output

Performs the unary - operation.

impl Neg for bf16

type Output = bf16

The resulting type after applying the - operator.

fn neg(self) -> <bf16 as Neg>::Output

Performs the unary - operation.

impl Normalize for bf16

fn normalize(x: Self) -> Self

fn __expand_normalize( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl Num for bf16

type FromStrRadixErr = <f32 as Num>::FromStrRadixErr

fn from_str_radix( str: &str, radix: u32, ) -> Result<bf16, <bf16 as Num>::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl NumCast for bf16

fn from<T>(n: T) -> Option<bf16>

where T: ToPrimitive,

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl Numeric for bf16

fn min_value() -> bf16

fn max_value() -> bf16

fn __expand_min_value(scope: &mut Scope) -> Self::ExpandType

fn __expand_max_value(scope: &mut Scope) -> Self::ExpandType

fn from_int(val: i64) -> Self

Create a new constant numeric.

fn from_vec<const D: usize>(_vec: [u32; D]) -> Self

fn __expand_from_int( scope: &mut Scope, val: ExpandElementTyped<i64>, ) -> Self::ExpandType

impl Octal for bf16

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

Formats the value using the given formatter.

impl One for bf16

fn one() -> bf16

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

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: &bf16) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &bf16) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &bf16) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &bf16) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Powf for bf16

fn powf(self, _rhs: Self) -> Self

fn __expand_powf( scope: &mut Scope, lhs: ExpandElementTyped<Self>, rhs: ExpandElementTyped<Self>, ) -> ExpandElementTyped<Self>

impl Powi<i32> for bf16

fn powi(self, _rhs: Rhs) -> Self

fn __expand_powi( scope: &mut Scope, lhs: ExpandElementTyped<Self>, rhs: ExpandElementTyped<Rhs>, ) -> ExpandElementTyped<Self>

impl<'a> Product<&'a bf16> for bf16

fn product<I>(iter: I) -> bf16

where I: Iterator<Item = &'a bf16>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl Product for bf16

fn product<I>(iter: I) -> bf16

where I: Iterator<Item = bf16>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl Recip for bf16

fn recip(x: Self) -> Self

fn __expand_recip( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl<B> Record<B> for bf16

where B: Backend,

type Item<S: PrecisionSettings> = bf16

Type of the item that can be serialized and deserialized.

fn into_item<S>(self) -> <bf16 as Record<B>>::Item<S>

where S: PrecisionSettings,

Convert the current record into the corresponding item that follows the given settings.

fn from_item<S>( item: <bf16 as Record<B>>::Item<S>, _device: &<B as Backend>::Device, ) -> bf16

where S: PrecisionSettings,

Convert the given item into a record.

impl ReducePrecision for bf16

type EI = bf16

Precision used for the input tensor.

type EA = f32

Precision used for the accumulation.

impl Rem<&bf16> for &bf16

type Output = <bf16 as Rem>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: &bf16) -> <&bf16 as Rem<&bf16>>::Output

Performs the % operation.

impl Rem<&bf16> for bf16

type Output = <bf16 as Rem>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: &bf16) -> <bf16 as Rem<&bf16>>::Output

Performs the % operation.

impl Rem<bf16> for &bf16

type Output = <bf16 as Rem>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: bf16) -> <&bf16 as Rem<bf16>>::Output

Performs the % operation.

impl Rem for bf16

type Output = bf16

The resulting type after applying the % operator.

fn rem(self, rhs: bf16) -> <bf16 as Rem>::Output

Performs the % operation.

impl RemAssign<&bf16> for bf16

fn rem_assign(&mut self, rhs: &bf16)

Performs the %= operation.

impl RemAssign for bf16

fn rem_assign(&mut self, rhs: bf16)

Performs the %= operation.

impl Remainder for bf16

fn rem(self, _rhs: Self) -> Self

fn __expand_rem( scope: &mut Scope, lhs: ExpandElementTyped<Self>, rhs: ExpandElementTyped<Self>, ) -> ExpandElementTyped<Self>

impl Round for bf16

fn round(x: Self) -> Self

fn __expand_round( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl SampleUniform for bf16

type Sampler = BFloat16Sampler

The UniformSampler implementation supporting type X.

impl Scalar for bf16

type Mask<S: Simd> = <S as Simd>::Mask16

fn lanes<S>() -> usize

where S: Simd,

unsafe fn vload<S>(ptr: *const bf16) -> Vector<S, bf16>

where S: Simd,

Load a vector from an aligned element pointer. Must be aligned to the whole vector.

unsafe fn vload_unaligned<S>(ptr: *const bf16) -> Vector<S, bf16>

where S: Simd,

Load a vector from an unaligned element pointer.

unsafe fn vload_low<S>(ptr: *const bf16) -> Vector<S, bf16>

where S: Simd,

Load the lower half of a vector from an unaligned element pointer.

unsafe fn vload_high<S>(ptr: *const bf16) -> Vector<S, bf16>

where S: Simd,

Load the upper half of a vector from an unaligned element pointer.

unsafe fn vstore<S>(ptr: *mut bf16, value: Vector<S, bf16>)

where S: Simd,

Store the lower half of a vector to an aligned element pointer. Must be aligned to the whole vector.

unsafe fn vstore_unaligned<S>(ptr: *mut bf16, value: Vector<S, bf16>)

where S: Simd,

Store the upper half of a vector to an unaligned element pointer.

unsafe fn vstore_low<S>(ptr: *mut bf16, value: Vector<S, bf16>)

where S: Simd,

Store the upper half of a vector to an unaligned element pointer.

unsafe fn vstore_high<S>(ptr: *mut bf16, value: Vector<S, bf16>)

where S: Simd,

Store the upper half of a vector to an unaligned element pointer.

unsafe fn mask_store_as_bool<S>(out: *mut bool, mask: <bf16 as Scalar>::Mask<S>)

where S: Simd,

Store a Mask as a set of booleans of lanes width, converting as necessary.

fn mask_from_bools<S>(bools: &[bool]) -> <bf16 as Scalar>::Mask<S>

where S: Simd,

Converts a slice of booleans to a mask. Slice length must be equal to lanes.

fn splat<S>(self) -> Vector<S, bf16>

where S: Simd,

Create a vector with the scalar value in each element.

fn align_to<S>(data: &[Self]) -> (&[Self], &[Vector<S, Self>], &[Self])

where S: Simd,

Convert slice into a head slice containing as many vectorized values as possible, and a tail slice, containing the leftover elements.

impl ScalarArgSettings for bf16

fn register<R>(&self, settings: &mut KernelLauncher<R>)

where R: Runtime,

Register the information to the [KernelLauncher].

fn expand_scalar( _: &ScalarCompilationArg<Self>, builder: &mut KernelBuilder, ) -> ExpandElementTyped<Self>

impl Serialize for bf16

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Signed for bf16

fn abs(&self) -> bf16

Computes the absolute value.

fn abs_sub(&self, other: &bf16) -> bf16

The positive difference of two numbers.

fn signum(&self) -> bf16

Returns the sign of the number.

fn is_positive(&self) -> bool

Returns true if the number is positive and false if the number is zero or negative.

fn is_negative(&self) -> bool

Returns true if the number is negative and false if the number is zero or positive.

impl Sin for bf16

fn sin(x: Self) -> Self

fn __expand_sin( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl Sqrt for bf16

fn sqrt(x: Self) -> Self

fn __expand_sqrt( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl Sub<&bf16> for &bf16

type Output = <bf16 as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: &bf16) -> <&bf16 as Sub<&bf16>>::Output

Performs the - operation.

impl Sub<&bf16> for bf16

type Output = <bf16 as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: &bf16) -> <bf16 as Sub<&bf16>>::Output

Performs the - operation.

impl Sub<bf16> for &bf16

type Output = <bf16 as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: bf16) -> <&bf16 as Sub<bf16>>::Output

Performs the - operation.

impl Sub for bf16

type Output = bf16

The resulting type after applying the - operator.

fn sub(self, rhs: bf16) -> <bf16 as Sub>::Output

Performs the - operation.

impl SubAssign<&bf16> for bf16

fn sub_assign(&mut self, rhs: &bf16)

Performs the -= operation.

impl SubAssign for bf16

fn sub_assign(&mut self, rhs: bf16)

Performs the -= operation.

impl<'a> Sum<&'a bf16> for bf16

fn sum<I>(iter: I) -> bf16

where I: Iterator<Item = &'a bf16>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for bf16

fn sum<I>(iter: I) -> bf16

where I: Iterator<Item = bf16>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Tanh for bf16

fn tanh(x: Self) -> Self

fn __expand_tanh( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl ToBytes for bf16

type Bytes = [u8; 2]

fn to_be_bytes(&self) -> <bf16 as ToBytes>::Bytes

Return the memory representation of this number as a byte array in big-endian byte order.

fn to_le_bytes(&self) -> <bf16 as ToBytes>::Bytes

Return the memory representation of this number as a byte array in little-endian byte order.

fn to_ne_bytes(&self) -> <bf16 as ToBytes>::Bytes

Return the memory representation of this number as a byte array in native byte order.

impl ToElement for bf16

fn to_i64(&self) -> i64

Converts the value of self to an i64.

fn to_u64(&self) -> u64

Converts the value of self to a u64.

fn to_i8(&self) -> i8

Converts the value of self to an i8.

fn to_u8(&self) -> u8

Converts the value of self to a u8.

fn to_i16(&self) -> i16

Converts the value of self to an i16.

fn to_u16(&self) -> u16

Converts the value of self to a u16.

fn to_i32(&self) -> i32

Converts the value of self to an i32.

fn to_u32(&self) -> u32

Converts the value of self to a u32.

fn to_bf16(&self) -> bf16

Converts the value of self to an bf16. Overflows may map to positive or negative infinity.

fn to_f32(&self) -> f32

Converts the value of self to an f32. Overflows may map to positive or negative infinity.

fn to_f64(&self) -> f64

Converts the value of self to an f64. Overflows may map to positive or negative infinity.

fn to_bool(&self) -> bool

Converts the value of self to a bool. Rust only considers 0 and 1 to be valid booleans, but for compatibility, C semantics are adopted (anything that’s not 0 is true).

fn to_isize(&self) -> isize

Converts the value of self to an isize.

fn to_i128(&self) -> i128

Converts the value of self to an i128.

fn to_usize(&self) -> usize

Converts the value of self to a usize.

fn to_u128(&self) -> u128

Converts the value of self to a u128.

fn to_f16(&self) -> f16

Converts the value of self to an f16. Overflows may map to positive or negative infinity.

impl ToPrimitive for bf16

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

impl Trunc for bf16

fn trunc(x: Self) -> Self

fn __expand_trunc( scope: &mut Scope, x: Self::ExpandType, ) -> ExpandElementTyped<Self>

impl TryFromBytes for bf16

where u16: TryFromBytes,

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the given source as a &Self with a DST length equal to count.

fn try_ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the prefix of the given source as a &Self with a DST length equal to count.

fn try_ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the suffix of the given source as a &Self with a DST length equal to count.

fn try_mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self with a DST length equal to count.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl UpperExp for bf16

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

Formats the value using the given formatter.

impl UpperHex for bf16

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

Formats the value using the given formatter.

impl Weight for bf16

const ZERO: bf16 = Self::ZERO

Representation of 0

fn checked_add_assign(&mut self, v: &bf16) -> Result<(), ()>

Checked addition

impl Zero for bf16

fn zero() -> bf16

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Zeroable for bf16

fn zeroed() -> Self

Calls zeroed.

impl Copy for bf16

impl Immutable for bf16

where u16: Immutable,

impl Pod for bf16