Struct strict_num::FiniteF32

#[repr(transparent)]
pub struct FiniteF32(_);

An immutable, finite f32.

Unlike f32, implements Ord, PartialOrd and Hash.

Implementations

impl FiniteF32

pub fn new(n: f32) -> Option<Self>

Creates a finite f32.

Returns None for NaN and infinity.

pub const unsafe fn new_unchecked(n: f32) -> Self

Creates a finite f32 without checking the value.

Safety

n must be finite.

pub const fn get(&self) -> f32

Returns the value as a primitive type.

Trait Implementations

impl ApproxEq for FiniteF32

type Margin = F32Margin

This type type defines a margin within which two values are to be considered approximately equal. It must implement Default so that approx_eq() can be called on unknown types.

fn approx_eq<M: Into<Self::Margin>>(self, other: Self, margin: M) -> bool

This method tests that the self and other values are equal within margin of each other.

fn approx_ne<M>(self, other: Self, margin: M) -> bool where
    M: Into<Self::Margin>, 

This method tests that the self and other values are not within margin of each other.

impl ApproxEqUlps for FiniteF32

type Flt = f32

fn approx_eq_ulps(&self, other: &Self, ulps: i32) -> bool

This method tests for self and other values to be approximately equal within ULPs (Units of Least Precision) floating point representations. Differing signs are always unequal with this method, and zeroes are only equal to zeroes. Use approx_eq() from the ApproxEq trait if that is more appropriate.

fn approx_ne_ulps(&self, other: &Self, ulps: <Self::Flt as Ulps>::U) -> bool

This method tests for self and other values to be not approximately equal within ULPs (Units of Least Precision) floating point representations. Differing signs are always unequal with this method, and zeroes are only equal to zeroes. Use approx_eq() from the ApproxEq trait if that is more appropriate.

impl Clone for FiniteF32

fn clone(&self) -> FiniteF32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FiniteF32

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

Formats the value using the given formatter.

impl Default for FiniteF32

fn default() -> FiniteF32

Returns the “default value” for a type.

impl Display for FiniteF32

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

Formats the value using the given formatter.

impl Hash for FiniteF32

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for FiniteF32

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<FiniteF32> for FiniteF32

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<FiniteF32> for FiniteF32

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for FiniteF32

impl Eq for FiniteF32