Struct cgmath::Relative

pub struct Relative<A, B = A> where
    A: RelativeEq<B> + ?Sized,
    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<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.

Methods

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

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

Replace the epsilon value with the one specified.

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

Replace the maximum relative value with the one specified.

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

Peform the equality comparison

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

Peform the inequality comparison

Trait Implementations

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

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

Returns the "default value" for a type.