pub struct ComptimeFloat<F>(/* private fields */)
where
F: FloatBits;Expand description
A finite float usable as a comptime kernel parameter.
Plain floats can’t back a Hash/Eq key because NaN breaks reflexivity,
which is required for anything used as a kernel cache key (e.g. through
KernelId::info). ComptimeFloat closes that gap by comparing and hashing
bit patterns instead, after rejecting non-finite input and normalizing -0.0
to 0.0 so numerically equal values always compare equal.
This is only appropriate for values that are genuinely arbitrary floats. If
a value is always an exact ratio of two integers (e.g. derived from tensor
shapes), prefer Ratio: it is exact and avoids bit-pattern
comparisons entirely.
Implementations§
Source§impl<F> ComptimeFloat<F>where
F: FloatBits,
impl<F> ComptimeFloat<F>where
F: FloatBits,
Sourcepub fn new(val: F) -> Result<ComptimeFloat<F>, InvalidComptimeFloat<F>>
pub fn new(val: F) -> Result<ComptimeFloat<F>, InvalidComptimeFloat<F>>
Wrap val, rejecting non-finite input.
Trait Implementations§
Source§impl<F> Clone for ComptimeFloat<F>
impl<F> Clone for ComptimeFloat<F>
Source§fn clone(&self) -> ComptimeFloat<F>
fn clone(&self) -> ComptimeFloat<F>
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreimpl<F> Copy for ComptimeFloat<F>
Source§impl<F> Debug for ComptimeFloat<F>
impl<F> Debug for ComptimeFloat<F>
Source§impl<F> Display for ComptimeFloat<F>where
F: FloatBits,
impl<F> Display for ComptimeFloat<F>where
F: FloatBits,
impl<F> Eq for ComptimeFloat<F>where
F: FloatBits,
Source§impl<F> Hash for ComptimeFloat<F>where
F: FloatBits,
impl<F> Hash for ComptimeFloat<F>where
F: FloatBits,
Auto Trait Implementations§
impl<F> Freeze for ComptimeFloat<F>where
F: Freeze,
impl<F> RefUnwindSafe for ComptimeFloat<F>where
F: RefUnwindSafe,
impl<F> Send for ComptimeFloat<F>where
F: Send,
impl<F> Sync for ComptimeFloat<F>where
F: Sync,
impl<F> Unpin for ComptimeFloat<F>where
F: Unpin,
impl<F> UnsafeUnpin for ComptimeFloat<F>where
F: UnsafeUnpin,
impl<F> UnwindSafe for ComptimeFloat<F>where
F: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.