Struct Bf16 

pub struct Bf16(pub bf16);

A bfloat16 scalar in tenferro’s scalar contract.

The representation is bf16, and the wrapper carries no extra state.

Examples

use tenferro_bf16_proof::Bf16;

let value = Bf16::from_f32(1.5);
assert_eq!(value.to_f32(), 1.5);
assert_eq!(value.narrow(), half::bf16::from_f32(1.5));

Tuple Fields

0: bf16

Implementations

impl Bf16

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

Wrap a bfloat16 value.

Examples

use tenferro_bf16_proof::Bf16;

assert_eq!(Bf16::of(half::bf16::from_f32(2.0)).to_f32(), 2.0);

pub const fn narrow(self) -> bf16

The stored bfloat16 value.

Examples

use tenferro_bf16_proof::Bf16;

assert_eq!(Bf16::from_f32(1.0).narrow(), half::bf16::from_f32(1.0));

pub fn from_f64(value: f64) -> Self

Round an f64 to bfloat16, which is the only way a stored value is produced.

Examples

use tenferro_bf16_proof::Bf16;

// The spacing of bfloat16 on [1, 2) is 2^-8, so 1.001 is nearer to 1.0 than to the next
// representable value above it.
let stored = Bf16::from_f64(1.001);
assert_eq!(stored.to_f32(), 1.0);

pub fn from_f32(value: f32) -> Self

Round an f32 to bfloat16.

Examples

use tenferro_bf16_proof::Bf16;

assert_eq!(Bf16::from_f32(0.5).to_f32(), 0.5);

pub fn to_f32(self) -> f32

Widen the stored value to f32, which is exact.

Examples

use tenferro_bf16_proof::Bf16;

let stored = Bf16::from_f64(1.0 + 2f64.powi(-10));
assert_eq!(stored.to_f32(), 1.0);

pub fn to_f64(self) -> f64

Widen the stored value to f64, which is exact.

Examples

use tenferro_bf16_proof::Bf16;

assert_eq!(Bf16::from_f32(2.5).to_f64(), 2.5);

pub const fn zero() -> Self

Additive identity.

Examples

use tenferro_bf16_proof::Bf16;

assert_eq!(Bf16::zero().to_f32(), 0.0);

pub fn one() -> Self

Multiplicative identity.

Examples

use tenferro_bf16_proof::Bf16;

assert_eq!(Bf16::one().to_f32(), 1.0);

Trait Implementations

impl Add for Bf16

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

Add in f32 and round the sum once.

Examples

use tenferro_bf16_proof::Bf16;

assert_eq!((Bf16::from_f32(1.0) + Bf16::from_f32(2.0)).to_f32(), 3.0);

type Output = Bf16

The resulting type after applying the + operator.

impl BinaryScalarOp<Bf16> for Bf16Add

fn apply(lhs: Bf16, rhs: Bf16) -> Bf16

Apply the operation.

impl BinaryScalarOp<Bf16> for Bf16Sub

fn apply(lhs: Bf16, rhs: Bf16) -> Bf16

Apply the operation.

impl BinaryScalarOp<Bf16> for Bf16Mul

fn apply(lhs: Bf16, rhs: Bf16) -> Bf16

Apply the operation.

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

impl Debug for Bf16

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

Formats the value using the given formatter.

impl Default for Bf16

fn default() -> Bf16

Returns the “default value” for a type.

impl Mul for Bf16

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

Multiply in f32 and round the product once.

Examples

use tenferro_bf16_proof::Bf16;

assert_eq!((Bf16::from_f32(3.0) * Bf16::from_f32(4.0)).to_f32(), 12.0);

type Output = Bf16

The resulting type after applying the * operator.

impl Neg for Bf16

fn neg(self) -> Self

Negate, which flips the sign bit and needs no rounding.

Examples

use tenferro_bf16_proof::Bf16;

assert_eq!((-Bf16::from_f32(2.0)).to_f32(), -2.0);

type Output = Bf16

The resulting type after applying the - operator.

impl PartialEq for Bf16

fn eq(&self, other: &Bf16) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Scalar for Bf16

const DOMAIN: ScalarDomain = tenferro_tensor_core::ScalarDomain::Field

Algebra of this scalar’s ordinary arithmetic.

impl ScalarArithmetic for Bf16

fn scalar_zero() -> Self

Additive identity.

fn scalar_one() -> Self

Multiplicative identity.

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

Sum under this scalar’s own semantics.

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

Difference under this scalar’s own semantics.

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

Product under this scalar’s own semantics.

impl StructuralPartialEq for Bf16

impl Sub for Bf16

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

Subtract in f32 and round the difference once.

Examples

use tenferro_bf16_proof::Bf16;

assert_eq!((Bf16::from_f32(3.0) - Bf16::from_f32(2.0)).to_f32(), 1.0);

type Output = Bf16

The resulting type after applying the - operator.