Struct approx::Relative

source · [−]

pub struct Relative<A, B = A> where
    A: RelativeEq<B> + ?Sized,
    B: ?Sized,  {
    pub epsilon: A::Epsilon,
    pub max_relative: A::Epsilon,
}

Expand description

The requisite parameters for testing for approximate equality using a relative based comparison.

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

Example

use std::f64;
use approx::Relative;

Relative::default().eq(&1.0, &1.0);
Relative::default().epsilon(f64::EPSILON).eq(&1.0, &1.0);
Relative::default().max_relative(1.0).eq(&1.0, &1.0);
Relative::default().epsilon(f64::EPSILON).max_relative(1.0).eq(&1.0, &1.0);
Relative::default().max_relative(1.0).epsilon(f64::EPSILON).eq(&1.0, &1.0);

Fields

epsilon: A::Epsilon

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

max_relative: A::Epsilon

The relative tolerance for testing values that are far-apart.

Implementations

source

impl<A, B> Relative<A, B> where
A: RelativeEq + ?Sized,
B: ?Sized,

source

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

Replace the epsilon value with the one specified.

source

pub fn max_relative(self, max_relative: A::Epsilon) -> Relative<A, B>

Replace the maximum relative 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 Relative<A, B> where
A: RelativeEq + ?Sized,
B: ?Sized,

source

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

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

Auto Trait Implementations

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

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

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

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

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

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct approx::Relative

Example

Fields

Implementations

impl<A, B> Relative<A, B> where
A: RelativeEq<B> + ?Sized,
B: ?Sized,

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

pub fn max_relative(self, max_relative: A::Epsilon) -> Relative<A, B>

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

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

Trait Implementations

impl<A, B> Default for Relative<A, B> where
A: RelativeEq<B> + ?Sized,
B: ?Sized,

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct approx::Relative

Fields

Implementations

impl<A, B> Relative<A, B> where A: RelativeEq<B> + ?Sized, B: ?Sized,

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

pub fn max_relative(self, max_relative: A::Epsilon) -> Relative<A, B>

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

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

Trait Implementations

impl<A, B> Default for Relative<A, B> where A: RelativeEq<B> + ?Sized, B: ?Sized,

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<A, B> Relative<A, B> where
A: RelativeEq<B> + ?Sized,
B: ?Sized,

impl<A, B> Default for Relative<A, B> where
A: RelativeEq<B> + ?Sized,
B: ?Sized,

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

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

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

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

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

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, U> Into<U> for T where
U: From<T>,

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

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