[][src]Struct float_cmp::F64Margin

pub struct F64Margin {
    pub epsilon: f64,
    pub ulps: i64,

This type defines a margin within two f64 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.


epsilon: f64ulps: i64


impl F64Margin[src]

pub fn zero() -> F64Margin[src]

pub fn epsilon(self, epsilon: f64) -> Self[src]

pub fn ulps(self, ulps: i64) -> Self[src]

Trait Implementations

impl Clone for F64Margin[src]

impl Copy for F64Margin[src]

impl Debug for F64Margin[src]

impl Default for F64Margin[src]

impl From<(f64, i64)> for F64Margin[src]

Auto Trait Implementations

impl Send for F64Margin

impl Sync for F64Margin

impl Unpin for F64Margin

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.