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.

Implementations

impl<'a, T> Relative<'a, T>where T: ApproxEq,

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

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>

Replace the epsilon value with the one specified.

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

Replace the maximum relative value with the one specified.

pub fn eq(self) -> bool

Peform the equality comparison

pub fn ne(self) -> bool

Peform the inequality comparison