Struct e3m2 

#[repr(transparent)]
pub struct e3m2(pub u8);

6-bit E3M2 micro-float (padded to 8-bit storage).

Layout: sign(1) + exponent(3) + mantissa(2), bias=3. Range: ±28, supports infinities. Only 64 total codes; 26 (40.6%) fall in [−1, +1]. Exact integer dot products via exponent-sum binning (15 bins).

Examples

use numkong::e3m2;

let fp6 = e3m2::from_f32(2.5);
let float = fp6.to_f32();

Tuple Fields

0: u8

Implementations

impl e3m2

pub const ZERO: Self

Positive zero.

pub const ONE: Self

Positive one.

pub const NEG_ONE: Self

Negative one.

pub fn from_f32(value: f32) -> Self

pub fn to_f32(self) -> f32

pub fn is_nan(self) -> bool

Returns true if this value is NaN.

pub fn is_infinite(self) -> bool

Returns true if this value is positive or negative infinity.

pub fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

pub fn abs(self) -> Self

Returns the absolute value of self.

Trait Implementations

impl Add for e3m2

type Output = e3m2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Angular for e3m2

type Output = f32

fn angular(a: &[Self], b: &[Self]) -> Option<Self::Output>

fn cosine(a: &[Self], b: &[Self]) -> Option<Self::Output>

Alias for angular.

impl Angulars for e3m2

type SpatialResult = f32

Result type for angular distances.

unsafe fn angulars_packed( a: *const Self, packed: *const u8, c: *mut Self::SpatialResult, height: usize, width: usize, depth: usize, a_stride: usize, c_stride: usize, )

Computes angular distances between A rows and packed B columns.

unsafe fn angulars_symmetric( vectors: *const Self, n_vectors: usize, depth: usize, stride: usize, result: *mut Self::SpatialResult, result_stride: usize, row_start: usize, row_count: usize, )

Computes symmetric angular distance matrix.

impl Binary for e3m2

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

Formats the value using the given formatter.

impl Clone for e3m2

fn clone(&self) -> e3m2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for e3m2

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

Formats the value using the given formatter.

impl Default for e3m2

fn default() -> e3m2

Returns the “default value” for a type.

impl Display for e3m2

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

Formats the value using the given formatter.

impl Div for e3m2

type Output = e3m2

The resulting type after applying the / operator.

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

Performs the / operation.

impl Dot for e3m2

type Output = f32

fn dot(a: &[Self], b: &[Self]) -> Option<Self::Output>

fn inner(a: &[Self], b: &[Self]) -> Option<Self::Output>

Alias for dot.

impl Dots for e3m2

type Accumulator = f32

Accumulator type for the multiplication.

fn dots_packed_size(width: usize, depth: usize) -> usize

Returns the size in bytes needed for the packed B matrix buffer.

unsafe fn dots_pack( b: *const Self, width: usize, depth: usize, b_stride: usize, packed: *mut u8, )

Packs the B matrix into an optimized backend-specific layout.

unsafe fn dots_packed( a: *const Self, packed: *const u8, c: *mut Self::Accumulator, height: usize, width: usize, depth: usize, a_stride: usize, c_stride: usize, )

Computes C = A × Bᵀ using packed B.

unsafe fn dots_symmetric( vectors: *const Self, n_vectors: usize, depth: usize, stride: usize, result: *mut Self::Accumulator, result_stride: usize, row_start: usize, row_count: usize, )

Computes C = A × Aᵀ where C is symmetric.

impl EachBlend for e3m2

type Scalar = f32

fn each_blend( a: &[Self], b: &[Self], alpha: f32, beta: f32, result: &mut [Self], ) -> Option<()>

impl EachFMA for e3m2

type Scalar = f32

fn each_fma( a: &[Self], b: &[Self], c: &[Self], alpha: f32, beta: f32, result: &mut [Self], ) -> Option<()>

impl EachScale for e3m2

type Scalar = f32

fn each_scale( a: &[Self], alpha: f32, beta: f32, result: &mut [Self], ) -> Option<()>

impl EachSum for e3m2

fn each_sum(a: &[Self], b: &[Self], result: &mut [Self]) -> Option<()>

impl Euclidean for e3m2

type SqEuclideanOutput = f32

type EuclideanOutput = f32

fn sqeuclidean(a: &[Self], b: &[Self]) -> Option<Self::SqEuclideanOutput>

Squared Euclidean distance (L2²). Faster than euclidean for comparisons.

fn euclidean(a: &[Self], b: &[Self]) -> Option<Self::EuclideanOutput>

Euclidean distance (L2). True metric distance.

impl Euclideans for e3m2

type SpatialResult = f32

Result type for euclidean distances.

unsafe fn euclideans_packed( a: *const Self, packed: *const u8, c: *mut Self::SpatialResult, height: usize, width: usize, depth: usize, a_stride: usize, c_stride: usize, )

Computes euclidean distances between A rows and packed B columns.

unsafe fn euclideans_symmetric( vectors: *const Self, n_vectors: usize, depth: usize, stride: usize, result: *mut Self::SpatialResult, result_stride: usize, row_start: usize, row_count: usize, )

Computes symmetric euclidean distance matrix.

impl FloatConvertible for e3m2

type DimScalar = e3m2

Scalar type for individual sub-dimensions.

type Unpacked = [e3m2; 1]

Fixed-size array holding all unpacked sub-dimensions.

fn unpack(self) -> [e3m2; 1]

Unpack all logical sub-dimensions from this packed value.

fn pack(dims: [e3m2; 1]) -> Self

Pack sub-dimension scalars into a single storage value.

impl From<e3m2> for f32

fn from(value: e3m2) -> Self

Converts to this type from the input type.

impl From<f32> for e3m2

fn from(value: f32) -> Self

Converts to this type from the input type.

impl LowerHex for e3m2

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

Formats the value using the given formatter.

impl Mul for e3m2

type Output = e3m2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for e3m2

type Output = e3m2

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl NumberLike for e3m2

fn from_f32(v: f32) -> Self

Convert from f32 to this type.

fn to_f32(self) -> f32

Convert from this type to f32.

fn abs(self) -> Self

fn is_nan(self) -> bool

fn is_finite(self) -> bool

fn is_infinite(self) -> bool

fn has_subnormals() -> bool

fn max_value() -> f32

fn min_positive() -> f32

fn from_f64(v: f64) -> Self

Convert from f64 to this type (default: via f32 roundtrip).

fn to_f64(self) -> f64

Convert from this type to f64 (default: via f32 roundtrip).

fn has_infinity() -> bool

fn has_nan() -> bool

impl PartialEq for e3m2

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

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 ReduceMinMax for e3m2

const NONE_ON_SENTINEL: bool = false

Whether NK_SIZE_MAX indicates that the reduction produced no value.

type Output = e3m2

Output type for the min/max values — matches the C layer’s native type.

unsafe fn reduce_minmax_raw( data: *const Self, count: usize, stride_bytes: usize, ) -> Option<(Self::Output, usize, Self::Output, usize)>

Returns Some((min_value, min_index, max_value, max_index)) for raw pointer input with the specified stride, or None if all elements are NaN.

fn reduce_minmax( data: &[Self], stride_bytes: usize, ) -> Option<(Self::Output, usize, Self::Output, usize)>

Returns Some((min_value, min_index, max_value, max_index)) for the given data with the specified stride, or None if all elements are NaN.

impl ReduceMoments for e3m2

type SumOutput = f32

Type for the sum output.

type SumSqOutput = f32

Type for the sum-of-squares output.

unsafe fn reduce_moments_raw( data: *const Self, count: usize, stride_bytes: usize, ) -> (Self::SumOutput, Self::SumSqOutput)

Compute (sum, sum_of_squares) for raw pointer input with the given stride in bytes.

fn reduce_moments( data: &[Self], stride_bytes: usize, ) -> (Self::SumOutput, Self::SumSqOutput)

Compute (sum, sum_of_squares) for data with the given stride (in bytes). Use stride_bytes = size_of::<Self>() for contiguous data.

impl StorageElement for e3m2

fn zero() -> Self

The additive identity.

fn one() -> Self

The multiplicative identity.

fn dimensions_per_value() -> usize

Number of logical dimensions packed into one storage value. Default: 1 for all normal types. Override for sub-byte packed types.

impl Sub for e3m2

type Output = e3m2

The resulting type after applying the - operator.

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

Performs the - operation.

impl UpperHex for e3m2

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

Formats the value using the given formatter.

impl VDot for e3m2

fn vdot(a: &[Self], b: &[Self]) -> Option<Self::Output>

impl CastDtype for e3m2

impl Copy for e3m2

impl Eq for e3m2

impl StructuralPartialEq for e3m2