Struct approx::Ulps

source ·
pub struct Ulps<A, B = A>
where A: UlpsEq<B> + ?Sized, B: ?Sized,
{ pub epsilon: A::Epsilon, pub max_ulps: u32, }
Expand description

The requisite parameters for testing for approximate equality using an ULPs based comparison.

This is not normally used directly, rather via the assert_ulps_{eq|ne}! and ulps_{eq|ne}! macros.

§Example

use std::f64;
use approx::Ulps;

Ulps::default().eq(&1.0, &1.0);
Ulps::default().epsilon(f64::EPSILON).eq(&1.0, &1.0);
Ulps::default().max_ulps(4).eq(&1.0, &1.0);
Ulps::default().epsilon(f64::EPSILON).max_ulps(4).eq(&1.0, &1.0);
Ulps::default().max_ulps(4).epsilon(f64::EPSILON).eq(&1.0, &1.0);

Fields§

§epsilon: A::Epsilon

The tolerance to use when testing values that are close together.

§max_ulps: u32

The ULPs to tolerate when testing values that are far-apart.

Implementations§

source§

impl<A, B> Ulps<A, B>
where A: UlpsEq<B> + ?Sized, B: ?Sized,

source

pub fn epsilon(self, epsilon: A::Epsilon) -> Ulps<A, B>

Replace the epsilon value with the one specified.

source

pub fn max_ulps(self, max_ulps: u32) -> Ulps<A, B>

Replace the max ulps value with the one specified.

source

pub fn eq(self, lhs: &A, rhs: &B) -> bool

Peform the equality comparison

source

pub fn ne(self, lhs: &A, rhs: &B) -> bool

Peform the inequality comparison

Trait Implementations§

source§

impl<A, B> Default for Ulps<A, B>
where A: UlpsEq<B> + ?Sized, B: ?Sized,

source§

fn default() -> Ulps<A, B>

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

Auto Trait Implementations§

§

impl<A, B> Freeze for Ulps<A, B>
where <A as AbsDiffEq<B>>::Epsilon: Freeze, A: ?Sized, B: ?Sized,

§

impl<A, B> RefUnwindSafe for Ulps<A, B>
where <A as AbsDiffEq<B>>::Epsilon: RefUnwindSafe, A: ?Sized, B: ?Sized,

§

impl<A, B> Send for Ulps<A, B>
where <A as AbsDiffEq<B>>::Epsilon: Send, A: ?Sized, B: ?Sized,

§

impl<A, B> Sync for Ulps<A, B>
where <A as AbsDiffEq<B>>::Epsilon: Sync, A: ?Sized, B: ?Sized,

§

impl<A, B> Unpin for Ulps<A, B>
where <A as AbsDiffEq<B>>::Epsilon: Unpin, A: ?Sized, B: ?Sized,

§

impl<A, B> UnwindSafe for Ulps<A, B>
where <A as AbsDiffEq<B>>::Epsilon: UnwindSafe, A: ?Sized, B: ?Sized,

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> 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>,

§

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>,

§

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.