[−][src]Struct cgmath::Relative

pub struct Relative<'a, T> where
    T: 'a + ApproxEq,  {
    pub lhs: &'a T,
    pub rhs: &'a T,
    pub epsilon: <T as ApproxEq>::Epsilon,
    pub max_relative: <T as ApproxEq>::Epsilon,
}

The requisite parameters for testing for approximate equality.

Fields

lhs: &'a T

The left-hand side of the approximate equality comparison.

rhs: &'a T

The right-hand side of the approximate equality comparison.

epsilon: <T as ApproxEq>::Epsilon

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

max_relative: <T as ApproxEq>::Epsilon

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

Methods

impl<'a, T> Relative<'a, T> where
    T: ApproxEq, [src]

pub fn new(lhs: &'a T, rhs: &'a T) -> Relative<'a, T>[src]

The beginning of a chained equality expression, using a relative based comparison.

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

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

pub fn epsilon(self, epsilon: <T as ApproxEq>::Epsilon) -> Relative<'a, T>[src]

Replace the epsilon value with the one specified.

pub fn max_relative(
    self,
    max_relative: <T as ApproxEq>::Epsilon
) -> Relative<'a, T>[src]

Replace the maximum relative value with the one specified.

pub fn eq(self) -> bool[src]

Peform the equality comparison

pub fn ne(self) -> bool[src]

Peform the inequality comparison

Auto Trait Implementations

impl<'a, T> Unpin for Relative<'a, T> where
    <T as ApproxEq>::Epsilon: Unpin, 

impl<'a, T> Sync for Relative<'a, T> where
    T: Sync,
    <T as ApproxEq>::Epsilon: Sync, 

impl<'a, T> Send for Relative<'a, T> where
    T: Sync,
    <T as ApproxEq>::Epsilon: Send, 

impl<'a, T> UnwindSafe for Relative<'a, T> where
    T: RefUnwindSafe,
    <T as ApproxEq>::Epsilon: UnwindSafe, 

impl<'a, T> RefUnwindSafe for Relative<'a, T> where
    T: RefUnwindSafe,
    <T as ApproxEq>::Epsilon: RefUnwindSafe, 

Blanket Implementations

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.

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

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

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