# [−][src]Struct approx::Relative

    pub struct Relative<A: ?Sized, B = A> where
        A: RelativeEq<B>,
        B: ?Sized,  {
        pub epsilon: A::Epsilon,
        pub max_relative: A::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::Epsilon`

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

`max_relative: A::Epsilon`

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

## Methods

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

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

Replace the epsilon value with the one specified.

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

Replace the maximum relative value with the one specified.

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

Peform the equality comparison

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

Peform the inequality comparison

## Trait Implementations

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

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

Returns the "default value" for a type. Read more

## Auto Trait Implementations

### `impl<A: ?Sized, B: ?Sized> Send for Relative<A, B> where
<A as AbsDiffEq<B>>::Epsilon: Send,`

### `impl<A: ?Sized, B: ?Sized> Unpin for Relative<A, B> where
<A as AbsDiffEq<B>>::Epsilon: Unpin,`

### `impl<A: ?Sized, B: ?Sized> Sync for Relative<A, B> where
<A as AbsDiffEq<B>>::Epsilon: Sync,`

### `impl<A: ?Sized, B: ?Sized> UnwindSafe for Relative<A, B> where
<A as AbsDiffEq<B>>::Epsilon: UnwindSafe,`

### `impl<A: ?Sized, B: ?Sized> RefUnwindSafe for Relative<A, B> where
<A as AbsDiffEq<B>>::Epsilon: RefUnwindSafe,`

## Blanket Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

### `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.

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

Performs the conversion.

### `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.

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

Performs the conversion.

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

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

Mutably borrows from an owned value. Read more

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

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

Immutably borrows from an owned value. Read more

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

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

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)