Enum Fp8Format 

pub enum Fp8Format {
    E4M3,
    E5M2,
    UE8M0,
}

The 8-bit float formats, described by the field constants their host codecs publish.

Fp8Format::UE8M0 is the odd one: it carries no sign and no mantissa, so it is a bare exponent rather than an IEEE-style minifloat. It belongs here anyway because the question this enum answers — which 8-bit formats does the backend convert natively, and which need the software path — is the same question for it, and it is the scale type MXFP4 is defined on. The generic field arithmetic below does not serve it; the codec branches on it instead.

Variants

E4M3

E5M2

UE8M0

Implementations

impl Fp8Format

pub const fn exponent_bits(self) -> u32

pub const fn mantissa_bits(self) -> u32

pub const fn bias(self) -> u32

pub const fn max_value(self) -> f32

pub const fn max_code(self) -> u32

pub const fn nan_code(self) -> u32

Both formats have several NaN encodings and the payload is not carried across: the codecs truncate the source mantissa, the hardware paths do as they please. This is the code for a canonical NaN, which is what the codec returns for f32::NAN. Reading NAN instead would give e5m2 a payload no conversion produces.

pub const fn has_infinity(self) -> bool

pub const fn min_normal(self) -> f32

pub const fn subnormal_step(self) -> f32

pub fn of_type(ctx: &Context, ty: TypeHandle) -> Option<Self>

Trait Implementations

impl BitOr for Fp8Format

type Output = EnumSet<Fp8Format>

The resulting type after applying the | operator.

fn bitor(self, other: Fp8Format) -> EnumSet<Fp8Format>

Performs the | operation.

impl BitOr<EnumSet<Fp8Format>> for Fp8Format

type Output = EnumSet<Fp8Format>

The resulting type after applying the | operator.

fn bitor(self, other: EnumSet<Fp8Format>) -> EnumSet<Fp8Format>

Performs the | operation.

impl Clone for Fp8Format

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Fp8Format

impl Debug for Fp8Format

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

Formats the value using the given formatter.

impl EnumSetType for Fp8Format

const VARIANTS: u32 = 3u32

Number of variants in the enum.

fn to_bit(self) -> u32

Index of the bit representing this variant.

fn from_bit(bit: u32) -> Self

The variant a bit index stands for.

impl Eq for Fp8Format

impl Hash for Fp8Format

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 Not for Fp8Format

type Output = EnumSet<Fp8Format>

The resulting type after applying the ! operator.

fn not(self) -> EnumSet<Fp8Format>

Performs the unary ! operation.

impl PartialEq for Fp8Format

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Fp8Format