pub struct Relative<A, B = A>{
pub epsilon: <A as AbsDiffEq<B>>::Epsilon,
pub max_relative: <A as AbsDiffEq<B>>::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 as AbsDiffEq<B>>::Epsilon
The tolerance to use when testing values that are close together.
max_relative: <A as AbsDiffEq<B>>::Epsilon
The relative tolerance for testing values that are far-apart.
Implementations§
Source§impl<A, B> Relative<A, B>
impl<A, B> Relative<A, B>
Trait Implementations§
Auto Trait Implementations§
impl<A, B> Freeze for Relative<A, B>
impl<A, B> RefUnwindSafe for Relative<A, B>
impl<A, B> Send for Relative<A, B>
impl<A, B> Sync for Relative<A, B>
impl<A, B> Unpin for Relative<A, B>
impl<A, B> UnwindSafe for Relative<A, B>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.