Struct is_close::ComparatorBuilder

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

Builder for Comparator functions. It holds the following parameters:

• rel_tol: maximum difference for being considered close, relative to the magnitude of the input values. It defaults to DEFAULT_REL_TOL.
• abs_tol: maximum difference for being considered close, regardless of the magnitude of the input values. It defaults to DEFAULT_ABS_TOL.
• method: strategy of how to interpret relative tolerance. It defaults to Method::Weak.

Implementations

impl<T: Float> ComparatorBuilder<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

impl<'a, T: Float + 'a> ComparatorBuilder<T>

pub fn compile(&self) -> Comparator<'a, T>

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

Shorthand for compile().is_close(a, b)

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

Shorthand for compile().all_close(a, b)

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

Shorthand for compile().any_close(a, b)

Trait Implementations

impl<T: Clone + Float> Clone for ComparatorBuilder<T>

fn clone(&self) -> ComparatorBuilder<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.