Struct rin::math::Relative[−][src]

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

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>::Epsilon

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

max_relative: <A as AbsDiffEq>::Epsilon

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

Implementations

`impl<A, B> Relative<A, B> where B: ?Sized, A: RelativeEq + ?Sized,` [src]

`pub fn epsilon(self, epsilon: <A as AbsDiffEq>::Epsilon) -> Relative<A, B>`[src]

Replace the epsilon value with the one specified.

`pub fn max_relative( self, max_relative: <A as AbsDiffEq>::Epsilon ) -> Relative<A, B>`[src]

Replace the maximum relative value with the one specified.

`#[must_use] pub fn eq(self, lhs: &A, rhs: &B) -> bool`[src]

Peform the equality comparison

`#[must_use] pub fn ne(self, lhs: &A, rhs: &B) -> bool`[src]

Peform the inequality comparison

Trait Implementations

`impl<A, B> Default for Relative<A, B> where B: ?Sized, A: RelativeEq + ?Sized,` [src]

`pub fn default() -> Relative<A, B>`[src]

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

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Any for T where T: Any,` [src]

`pub fn get_type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Downcast for T where T: Any,` [src]

`pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>`[src]

`pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>`[src]

`pub fn as_any(&self) -> &(dyn Any + 'static)`[src]

`pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)`[src]

`impl<T> DowncastSync for T where T: Any + Send + Sync,` [src]

`pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Send + Sync>`[src]

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

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<V> IntoPnt<V> for V`[src]

`pub fn into_pnt(self) -> V`[src]

`impl<V> IntoVec<V> for V`[src]

`pub fn into_vec(self) -> V`[src]

`impl<T> Pointable for T`[src]

`pub const ALIGN: usize`[src]

`type Init = T`

The type for initializers.

`pub unsafe fn init(init: <T as Pointable>::Init) -> usize`[src]

`pub unsafe fn deref<'a>(ptr: usize) -> &'a T`[src]

`pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T`[src]

`pub unsafe fn drop(ptr: usize)`[src]

`impl<T> Same<T> for T`[src]

`type Output = T`

Should always be Self

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,` [src]

`pub fn to_subset(&self) -> Option<SS>`[src]

`pub fn is_in_subset(&self) -> bool`[src]

`pub fn to_subset_unchecked(&self) -> SS`[src]

`pub fn from_subset(element: &SS) -> SP`[src]

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,` [src]

`pub fn to_subset(&self) -> Option<SS>`[src]

`pub fn is_in_subset(&self) -> bool`[src]

`pub fn to_subset_unchecked(&self) -> SS`[src]

`pub fn from_subset(element: &SS) -> SP`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

`impl<V, T> VZip<V> for T where V: MultiLane<T>,` [src]

`pub fn vzip(self) -> V`[src]

Struct rin::math::Relative⎘[−][src]

Example

Fields

Implementations

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

pub fn epsilon(self, epsilon: <A as AbsDiffEq<B>>::Epsilon) -> Relative<A, B>[src]

pub fn max_relative( self, max_relative: <A as AbsDiffEq<B>>::Epsilon) -> Relative<A, B>[src]

#[must_use]pub fn eq(self, lhs: &A, rhs: &B) -> bool[src]

#[must_use]pub fn ne(self, lhs: &A, rhs: &B) -> bool[src]

Trait Implementations

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

pub fn default() -> Relative<A, B>[src]

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, [src]

pub fn type_id(&self) -> TypeId[src]

impl<T> Any for T where T: Any, [src]

pub fn get_type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

impl<T> Downcast for T where T: Any, [src]

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>[src]

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>[src]

pub fn as_any(&self) -> &(dyn Any + 'static)[src]

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)[src]

impl<T> DowncastSync for T where T: Any + Send + Sync, [src]

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Send + Sync>[src]

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

pub fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

pub fn into(self) -> U[src]

impl<V> IntoPnt<V> for V[src]

pub fn into_pnt(self) -> V[src]

impl<V> IntoVec<V> for V[src]

pub fn into_vec(self) -> V[src]

impl<T> Pointable for T[src]

pub const ALIGN: usize[src]

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize[src]

pub unsafe fn deref<'a>(ptr: usize) -> &'a T[src]

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T[src]

pub unsafe fn drop(ptr: usize)[src]

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

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>, [src]

pub fn to_subset(&self) -> Option<SS>[src]

pub fn is_in_subset(&self) -> bool[src]

pub fn to_subset_unchecked(&self) -> SS[src]

pub fn from_subset(element: &SS) -> SP[src]

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>, [src]

pub fn to_subset(&self) -> Option<SS>[src]

pub fn is_in_subset(&self) -> bool[src]

pub fn to_subset_unchecked(&self) -> SS[src]

pub fn from_subset(element: &SS) -> SP[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>, [src]

pub fn vzip(self) -> V[src]

Struct rin::math::Relative[−][src]

`impl<A, B> Relative<A, B> where B: ?Sized, A: RelativeEq<B> + ?Sized,` [src]

`pub fn epsilon(self, epsilon: <A as AbsDiffEq<B>>::Epsilon) -> Relative<A, B>`[src]

`pub fn max_relative( self, max_relative: <A as AbsDiffEq<B>>::Epsilon ) -> Relative<A, B>`[src]

`#[must_use] pub fn eq(self, lhs: &A, rhs: &B) -> bool`[src]

`#[must_use] pub fn ne(self, lhs: &A, rhs: &B) -> bool`[src]

`impl<A, B> Default for Relative<A, B> where B: ?Sized, A: RelativeEq<B> + ?Sized,` [src]

`pub fn default() -> Relative<A, B>`[src]

`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,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Any for T where T: Any,` [src]

`pub fn get_type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Downcast for T where T: Any,` [src]

`pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>`[src]

`pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>`[src]

`pub fn as_any(&self) -> &(dyn Any + 'static)`[src]

`pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)`[src]

`impl<T> DowncastSync for T where T: Any + Send + Sync,` [src]

`pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Send + Sync>`[src]

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

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<V> IntoPnt<V> for V`[src]

`pub fn into_pnt(self) -> V`[src]

`impl<V> IntoVec<V> for V`[src]

`pub fn into_vec(self) -> V`[src]

`impl<T> Pointable for T`[src]

`pub const ALIGN: usize`[src]

`type Init = T`

`pub unsafe fn init(init: <T as Pointable>::Init) -> usize`[src]

`pub unsafe fn deref<'a>(ptr: usize) -> &'a T`[src]

`pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T`[src]

`pub unsafe fn drop(ptr: usize)`[src]

`impl<T> Same<T> for T`[src]

`type Output = T`

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,` [src]

`pub fn to_subset(&self) -> Option<SS>`[src]

`pub fn is_in_subset(&self) -> bool`[src]

`pub fn to_subset_unchecked(&self) -> SS`[src]

`pub fn from_subset(element: &SS) -> SP`[src]

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,` [src]

`pub fn to_subset(&self) -> Option<SS>`[src]

`pub fn is_in_subset(&self) -> bool`[src]

`pub fn to_subset_unchecked(&self) -> SS`[src]

`pub fn from_subset(element: &SS) -> SP`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

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

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

`impl<V, T> VZip<V> for T where V: MultiLane<T>,` [src]

`pub fn vzip(self) -> V`[src]