[][src]Struct predicates::float::IsClosePredicate

pub struct IsClosePredicate { /* fields omitted */ }

Predicate that ensures two numbers are "close" enough, understanding that rounding errors occur.

This is created by the predicate::float::is_close.

Methods

impl IsClosePredicate[src]

pub fn distance(self, distance: <f64 as Ulps>::U) -> Self[src]

Set the amount of error allowed.

Values 1-5 should work in most cases. Sometimes more control is needed and you will need to set IsClosePredicate::epsilon separately from IsClosePredicate::ulps.

Examples

use predicates::prelude::*;

let a = 0.15_f64 + 0.15_f64 + 0.15_f64;
let predicate_fn = predicate::float::is_close(a).distance(5);

pub fn epsilon(self, epsilon: f64) -> Self[src]

Set the absolute deviation allowed.

This is meant to handle problems near 0. Values 1.-5. epislons should work in most cases.

Examples

use predicates::prelude::*;

let a = 0.15_f64 + 0.15_f64 + 0.15_f64;
let predicate_fn = predicate::float::is_close(a).epsilon(5.0 * ::std::f64::EPSILON);

pub fn ulps(self, ulps: <f64 as Ulps>::U) -> Self[src]

Set the relative deviation allowed.

This is meant to handle large numbers. Values 1-5 should work in most cases.

Examples

use predicates::prelude::*;

let a = 0.15_f64 + 0.15_f64 + 0.15_f64;
let predicate_fn = predicate::float::is_close(a).ulps(5);

Trait Implementations

impl Copy for IsClosePredicate[src]

impl PartialEq<IsClosePredicate> for IsClosePredicate[src]

impl Clone for IsClosePredicate[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Display for IsClosePredicate[src]

impl Debug for IsClosePredicate[src]

impl Predicate<f64> for IsClosePredicate[src]

impl PredicateReflection for IsClosePredicate[src]

fn children(&'a self) -> Box<dyn Iterator<Item = Child<'a>> + 'a>[src]

Nested Predicates of the current Predicate.

Auto Trait Implementations

Blanket Implementations

impl<P, Item> PredicateNameExt for P where
    Item: ?Sized,
    P: Predicate<Item>, 
[src]

fn name(self, name: &'static str) -> NamePredicate<Self, Item> where
    Self: Sized
[src]

Name a predicate expression. Read more

impl<P, Item> PredicateBooleanExt for P where
    Item: ?Sized,
    P: Predicate<Item>, 
[src]

fn and<B>(self, other: B) -> AndPredicate<Self, B, Item> where
    B: Predicate<Item>,
    Self: Sized
[src]

Compute the logical AND of two Predicate results, returning the result. Read more

fn or<B>(self, other: B) -> OrPredicate<Self, B, Item> where
    B: Predicate<Item>,
    Self: Sized
[src]

Compute the logical OR of two Predicate results, returning the result. Read more

fn not(self) -> NotPredicate<Self, Item> where
    Self: Sized
[src]

Compute the logical NOT of a Predicate, returning the result. Read more

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

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> From for T[src]

impl<T> ToString for T where
    T: Display + ?Sized
[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.

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

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

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

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

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

The type returned in the event of a conversion error.