Struct Tolerance 

pub struct Tolerance<T>(/* private fields */)
where
    T: FloatBounds;

Type-safe tolerance parameter for convergence checking

Implementations

impl<T> Tolerance<T>

where T: FloatBounds,

pub fn new(tolerance: T) -> Result<Tolerance<T>, SklearsError>

Create a new tolerance value, must be positive

pub fn get(self) -> T

Get the raw tolerance value

pub fn default_for_type() -> Tolerance<T>

Default tolerance based on machine epsilon

pub fn strict() -> Tolerance<T>

Strict tolerance for high precision

pub fn relaxed() -> Tolerance<T>

Relaxed tolerance for fast convergence

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

Check if two values are within this tolerance

pub fn is_zero(self, value: T) -> bool

Check if a value is close to zero within this tolerance

pub fn check_relative_convergence(self, current: T, previous: T) -> bool

Check convergence based on relative change

Trait Implementations

impl<T> Clone for Tolerance<T>

where T: Clone + FloatBounds,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Tolerance<T>

where T: Debug + FloatBounds,

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

Formats the value using the given formatter.

impl<T> Display for Tolerance<T>

where T: FloatBounds,

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

Formats the value using the given formatter.

impl<T> PartialEq for Tolerance<T>

where T: PartialEq + FloatBounds,

fn eq(&self, other: &Tolerance<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> PartialOrd for Tolerance<T>

where T: PartialOrd + FloatBounds,

fn partial_cmp(&self, other: &Tolerance<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Copy for Tolerance<T>

where T: Copy + FloatBounds,

impl<T> StructuralPartialEq for Tolerance<T>

where T: FloatBounds,