Skip to main content

F4E2M1x2

Struct F4E2M1x2 

Source
pub struct F4E2M1x2(/* private fields */);
Expand description

Two F4E2M1 values packed into a single byte.

The lower nibble (bits 3:0) holds the first value and the upper nibble (bits 7:4) holds the second value. This layout matches NVIDIA’s __nv_fp4x2_e2m1 format.

§Examples

use float4::{F4E2M1, F4E2M1x2};

let lo = F4E2M1::from_f64(1.5);
let hi = F4E2M1::from_f64(-2.0);
let packed = F4E2M1x2::new(lo, hi);

assert_eq!(packed.lo().to_f64(), 1.5);
assert_eq!(packed.hi().to_f64(), -2.0);

Implementations§

Source§

impl F4E2M1x2

Source

pub const ZERO: Self

Two positive zeros.

Source

pub const fn new(lo: F4E2M1, hi: F4E2M1) -> Self

Packs two F4E2M1 values into a single byte.

lo occupies bits 3:0 and hi occupies bits 7:4.

Source

pub const fn from_bits(bits: u8) -> Self

Wraps a raw byte directly.

Source

pub const fn to_bits(self) -> u8

Returns the raw byte.

Source

pub const fn lo(self) -> F4E2M1

Extracts the lower nibble as an F4E2M1.

Source

pub const fn hi(self) -> F4E2M1

Extracts the upper nibble as an F4E2M1.

Source

pub fn from_f32_pair(a: f32, b: f32) -> Self

Creates a packed pair by converting two f32 values to F4E2M1.

Each value is independently rounded to the nearest representable F4E2M1 value using round-to-nearest-even.

§Examples
use float4::F4E2M1x2;

let packed = F4E2M1x2::from_f32_pair(1.5, -2.0);
assert_eq!(packed.lo().to_f64(), 1.5);
assert_eq!(packed.hi().to_f64(), -2.0);
Source

pub fn to_f32_pair(self) -> (f32, f32)

Extracts both values as an (f32, f32) pair.

§Examples
use float4::F4E2M1x2;

let packed = F4E2M1x2::from_f32_pair(3.0, -0.5);
let (a, b) = packed.to_f32_pair();
assert_eq!(a, 3.0);
assert_eq!(b, -0.5);

Trait Implementations§

Source§

impl Clone for F4E2M1x2

Source§

fn clone(&self) -> F4E2M1x2

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for F4E2M1x2

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for F4E2M1x2

Source§

fn default() -> F4E2M1x2

Returns the “default value” for a type. Read more
Source§

impl Display for F4E2M1x2

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<(F4E2M1, F4E2M1)> for F4E2M1x2

Source§

fn from((lo, hi): (F4E2M1, F4E2M1)) -> Self

Converts to this type from the input type.
Source§

impl From<F4E2M1x2> for (F4E2M1, F4E2M1)

Source§

fn from(packed: F4E2M1x2) -> Self

Converts to this type from the input type.
Source§

impl Hash for F4E2M1x2

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for F4E2M1x2

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for F4E2M1x2

Source§

impl Eq for F4E2M1x2

Source§

impl StructuralPartialEq for F4E2M1x2

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.