noteuclid/f8
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Add public API and docs #1

Open
noteuclid wants to merge 8 commits from api into master
pull from: api
merge into: noteuclid:master
Conversation 1 Commits 8 Files Changed 4 +11 -1
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 3b126e7fa6 - Show all commits

12
src/lib.rs
View File

@ -31,7 +31,17 @@ const E_BIAS: u8 = E_STORAGE_MAX - E_MAX;
const M_MASK: u8 = M_STORAGE_MAX; const M_MASK: u8 = M_STORAGE_MAX;
const E_MASK: u8 = E_STORAGE_MAX << M_BITS; const E_MASK: u8 = E_STORAGE_MAX << M_BITS;
/// 8-bit unsigned binary floating-point type, with [`M_BITS`] mantissa bits and [`E_BITS`] exponent bits. /// 8-bit unsigned binary floating-point type.
///
/// # Properties
///
/// * Mantissa width: 5 bits ([`M_BITS`])
/// * Exponent width: 3 bits ([`E_BITS`])
/// * Negative values: not supported
/// * Zero: special-cased
/// * Subnormals: not supported
/// * Infinity: not supported
/// * NaN: not supported
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Default)] #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Default)]
#[repr(transparent)] #[repr(transparent)]
pub struct F8(u8); pub struct F8(u8);