Struct RelativeParams

pub struct RelativeParams<T, E = T> {
    pub zero_thresh: E,
    pub max_relative: E,
    /* private fields */
}

A struct to use for approximate equality.

let test = RelativeParams::<f32>::new(Some(0.05), Some(0.001));
assert!(test.close_to(&1.0, &1.001));
assert!(test.close_to(&1001., &1000.));
assert!(test.close_to_zero(&-0.05));
assert!(! test.close_to(&0.1, &0.11));
assert!(! test.close_to_zero(&0.06));

Fields

zero_thresh: E

Below this threshold in absolute value, values are considered close to zero.

max_relative: E

Values not close to zero are considered close to each other if their relative error is at most this large.

Implementations

impl RelativeParams<f32, f32>

pub fn new(zero_thresh: Option<f32>, max_relative: Option<f32>) -> Self

Create a new closeness tester with the given parameters.

For both arguments, zero_thresh and max_relative, either the given bound is used, or machine epsilon if the argument is None.

impl RelativeParams<f64, f64>

pub fn new(zero_thresh: Option<f64>, max_relative: Option<f64>) -> Self

Create a new closeness tester with the given parameters.

For both arguments, zero_thresh and max_relative, either the given bound is used, or machine epsilon if the argument is None.

impl RelativeParams<Complex32, f32>

pub fn new(zero_thresh: Option<f32>, max_relative: Option<f32>) -> Self

Create a new closeness tester with the given parameters.

For both arguments, zero_thresh and max_relative, either the given bound is used, or machine epsilon if the argument is None.

impl RelativeParams<Complex64, f64>

pub fn new(zero_thresh: Option<f64>, max_relative: Option<f64>) -> Self

Create a new closeness tester with the given parameters.

For both arguments, zero_thresh and max_relative, either the given bound is used, or machine epsilon if the argument is None.

Trait Implementations

impl<T: Clone, E: Clone> Clone for RelativeParams<T, E>

fn clone(&self) -> RelativeParams<T, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CloseTo for RelativeParams<Complex32, f32>

type Item = Complex<f32>

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 CloseTo for RelativeParams<Complex64, f64>

type Item = Complex<f64>

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 CloseTo for RelativeParams<f32, f32>

type Item = f32

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 CloseTo for RelativeParams<f64, f64>

type Item = f64

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, E: Debug> Debug for RelativeParams<T, E>

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

Formats the value using the given formatter.

impl Default for RelativeParams<Complex32, f32>

fn default() -> Self

Create a closeness tester with machine epsilon precision.

impl Default for RelativeParams<Complex64, f64>

fn default() -> Self

Create a closeness tester with machine epsilon precision.

impl Default for RelativeParams<f32, f32>

fn default() -> Self

Create a closeness tester with machine epsilon precision.

impl Default for RelativeParams<f64, f64>

fn default() -> Self

Create a closeness tester with machine epsilon precision.

impl<T: PartialEq, E: PartialEq> PartialEq for RelativeParams<T, E>

fn eq(&self, other: &RelativeParams<T, E>) -> 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, E: Copy> Copy for RelativeParams<T, E>

impl<T: Eq, E: Eq> Eq for RelativeParams<T, E>

impl<T, E> StructuralPartialEq for RelativeParams<T, E>