Struct NumberAffinity

#[non_exhaustive]
#[repr(C)]
pub struct NumberAffinity<'shape> {
    pub bits: NumberBits,
    pub min: PtrConst<'shape>,
    pub max: PtrConst<'shape>,
    pub positive_infinity: Option<PtrConst<'shape>>,
    pub negative_infinity: Option<PtrConst<'shape>>,
    pub nan_sample: Option<PtrConst<'shape>>,
    pub positive_zero: Option<PtrConst<'shape>>,
    pub negative_zero: Option<PtrConst<'shape>>,
    pub epsilon: Option<PtrConst<'shape>>,
}

Definition for number-like scalar affinities

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bits: NumberBits

Bit representation of numbers

min: PtrConst<'shape>

Minimum representable value

max: PtrConst<'shape>

Maximum representable value

positive_infinity: Option<PtrConst<'shape>>

Positive infinity representable value

negative_infinity: Option<PtrConst<'shape>>

Negative infinity representable value

nan_sample: Option<PtrConst<'shape>>

Example NaN (Not a Number) value. Why sample? Because there are many NaN values, and we need to provide a representative one.

positive_zero: Option<PtrConst<'shape>>

Positive zero representation. If there’s only one zero, only set this one.

negative_zero: Option<PtrConst<'shape>>

Negative zero representation

epsilon: Option<PtrConst<'shape>>

“Machine epsilon” (https://en.wikipedia.org/wiki/Machine_epsilon), AKA relative approximation error, if relevant

Implementations

impl<'shape> NumberAffinity<'shape>

pub const fn builder() -> NumberAffinityBuilder<'shape>

Returns a builder for NumberAffinity

Trait Implementations

impl<'shape> Clone for NumberAffinity<'shape>

fn clone(&self) -> NumberAffinity<'shape>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'shape> Debug for NumberAffinity<'shape>

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

Formats the value using the given formatter.

impl<'shape> Hash for NumberAffinity<'shape>

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<'shape> PartialEq for NumberAffinity<'shape>

fn eq(&self, other: &NumberAffinity<'shape>) -> 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<'shape> Copy for NumberAffinity<'shape>

impl<'shape> Eq for NumberAffinity<'shape>

impl<'shape> StructuralPartialEq for NumberAffinity<'shape>