Struct float_cmp::F32Margin

source ·
#[repr(C)]
pub struct F32Margin { pub epsilon: f32, pub ulps: i32, }
Expand description

This type defines a margin within two f32 values might be considered equal, and is intended as the associated type for the ApproxEq trait.

Two tests are used to determine approximate equality.

The first test considers two values approximately equal if they differ by <= epsilon. This will only succeed for very small numbers. Note that it may succeed even if the parameters are of differing signs, straddling zero.

The second test considers how many ULPs (units of least precision, units in the last place, which is the integer number of floating-point representations that the parameters are separated by) different the parameters are and considers them approximately equal if this is <= ulps. For large floating-point numbers, an ULP can be a rather large gap, but this kind of comparison is necessary because floating-point operations must round to the nearest representable value and so larger floating-point values accumulate larger errors.

Fields§

§epsilon: f32§ulps: i32

Trait Implementations§

source§

impl Clone for F32Margin

source§

fn clone(&self) -> F32Margin

Returns a copy 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 F32Margin

source§

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

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

impl Default for F32Margin

source§

fn default() -> F32Margin

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

impl FloatMargin for F32Margin

source§

type F = f32

A floating-point type used for epsilon values
source§

type I = i32

An integer type used for ulps values
source§

fn zero() -> F32Margin

Zero margin
source§

fn epsilon(self, epsilon: f32) -> Self

Set the epsilon value for this margin
source§

fn ulps(self, ulps: i32) -> Self

Set the ulps value for this margin
source§

impl From<(f32, i32)> for F32Margin

source§

fn from(m: (f32, i32)) -> F32Margin

Converts to this type from the input type.
source§

impl Copy for F32Margin

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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, 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.