Struct is_close::IsClose

pub struct IsClose<T: Float> { /* fields omitted */ }

Compare two floats with some tolerance

This type holds information on how to compare floats and is heavily inspired by Python's PEP 485. It holds the following parameters:

• rel_tol: maximum difference for being considered "close", relative to the magnitude of the input values, defaults to 1e-8
• abs_tol: maximum difference for being considered "close", regardless of the magnitude of the input values, defaults to 0.0
• method: strategy of how to interpret relative tolerance, see Method

Implementations

impl<T: Float> IsClose<T>

pub fn rel_tol(&mut self, value: T) -> &mut Self

Set the relative tolerance

pub fn abs_tol(&mut self, value: T) -> &mut Self

Set the absolute tolerance

pub fn method<M: Into<Method>>(&mut self, method: M) -> &mut Self

Set the strategy used to handle relative tolerance

pub fn is_close(&self, a: T, b: T) -> bool

Check whether or not two values a and b are "close" to each other

pub fn all_close<I, J>(&self, a: I, b: J) -> bool where
    I: IntoIterator<Item = T>,
    J: IntoIterator<Item = T>, 

Check whether or not two iterables a and b are pairwise "close" to each other

pub fn any_close<I, J>(&self, a: I, b: J) -> bool where
    I: IntoIterator<Item = T>,
    J: IntoIterator<Item = T>, 

Check whether or not two iterables a and b are pairwise "close" to each other in at least one place

Trait Implementations

impl<T: Float + Debug> Debug for IsClose<T>

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

Formats the value using the given formatter.

impl<T: Float> Default for IsClose<T>

fn default() -> Self

Returns the "default value" for a type.