Struct CloseToEq

pub struct CloseToEq<T> {
    pub zero: T,
}

A struct to use for exact equality in the CloseTo trait.

let test = CloseToEq::new();
assert!(test.close_to(&15, &15));
assert!(! test.close_to(&15, &16));
assert!(test.close_to_zero(&0));

Fields

zero: T

The zero element (additive identity) for type T.

Implementations

impl<T: Zero> CloseToEq<T>

pub fn new() -> Self

Creates a new struct for exact equality, using num_traits::Zero::zero to get the zero element.

Trait Implementations

impl<T: Clone> Clone for CloseToEq<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq> CloseTo for CloseToEq<T>

type Item = T

The type of thing that can be compared.

fn close_to(&self, x: &Self::Item, y: &Self::Item) -> bool

Returns true iff x is approximatey equal to y.

fn close_to_zero(&self, x: &Self::Item) -> bool

Indicates true if x is approximately zero.

fn close_to_iter<'a, Iter1, Iter2>(&'a self, x: Iter1, y: Iter2) -> bool

where Iter1: Iterator<Item = &'a Self::Item>, Iter2: Iterator<Item = &'a Self::Item>,

Checks closeness over an iteration.

impl<T: Debug> Debug for CloseToEq<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for CloseToEq<T>

fn default() -> CloseToEq<T>

Returns the “default value” for a type.

impl<T: PartialEq> PartialEq for CloseToEq<T>

fn eq(&self, other: &CloseToEq<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Copy> Copy for CloseToEq<T>

impl<T: Eq> Eq for CloseToEq<T>

impl<T> StructuralPartialEq for CloseToEq<T>