Struct predicates::float::IsClosePredicate

source ·
pub struct IsClosePredicate { /* private fields */ }
Available on crate feature float-cmp only.
Expand description

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

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

Implementations§

source§

impl IsClosePredicate

source

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

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);
source

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

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 * f64::EPSILON);
source

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

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§

source§

impl Clone for IsClosePredicate

source§

fn clone(&self) -> IsClosePredicate

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for IsClosePredicate

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for IsClosePredicate

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl PartialEq for IsClosePredicate

source§

fn eq(&self, other: &IsClosePredicate) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Predicate<f64> for IsClosePredicate

source§

fn eval(&self, variable: &f64) -> bool

Execute this Predicate against variable, returning the resulting boolean.
source§

fn find_case<'a>(&'a self, expected: bool, variable: &f64) -> Option<Case<'a>>

Find a case that proves this predicate as expected when run against variable.
source§

impl PredicateReflection for IsClosePredicate

source§

fn parameters<'a>(&'a self) -> Box<dyn Iterator<Item = Parameter<'a>> + 'a>

Parameters of the current Predicate.
source§

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

Nested Predicates of the current Predicate.
source§

impl Copy for IsClosePredicate

source§

impl StructuralPartialEq for IsClosePredicate

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

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

source§

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

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

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

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

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

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

impl<P, Item> PredicateBoxExt<Item> for P
where P: Predicate<Item>,

source§

fn boxed(self) -> BoxPredicate<Item>
where Self: Sized + Send + Sync + 'static,

Returns a BoxPredicate wrapper around this Predicate type. Read more
source§

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

source§

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

Name a predicate expression. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.