Struct AbsoluteTolerance 

pub struct AbsoluteTolerance<RealType>(/* private fields */);

Type-safe wrapper for absolute tolerance values.

AbsoluteTolerance<T> represents a non-negative (≥ 0) tolerance value used for absolute error comparisons. It ensures that the tolerance is always valid by rejecting negative values at construction time.

Mathematical Definition

An absolute tolerance ε is used in comparisons like:

|a - b| ≤ ε

Since ε represents a distance or error bound, it must be non-negative.

Type Parameters

• RealType: The underlying real scalar type (e.g., f64, RealNative64StrictFinite)

Examples

Basic Usage

use num_valid::scalars::AbsoluteTolerance;
use try_create::TryNew;

// Create from f64
let tol = AbsoluteTolerance::try_new(1e-10_f64).unwrap();
assert_eq!(*tol.as_ref(), 1e-10);

// Use convenience constructors
let zero = AbsoluteTolerance::<f64>::zero();
let eps = AbsoluteTolerance::<f64>::epsilon();

In Numerical Comparisons

use num_valid::scalars::AbsoluteTolerance;
use num_valid::RealScalar;
use try_create::TryNew;

fn approximately_equal<T: RealScalar + Clone>(a: T, b: T, tol: &AbsoluteTolerance<T>) -> bool {
    let diff = (a - b).abs();
    &diff <= tol.as_ref()
}

let tol = AbsoluteTolerance::try_new(1e-10_f64).unwrap();
assert!(approximately_equal(1.0, 1.0 + 1e-11, &tol));
assert!(!approximately_equal(1.0, 1.0 + 1e-9, &tol));

Zero-Cost Abstraction

This type uses #[repr(transparent)] and has zero runtime overhead beyond the initial validation at construction time.

Implementations

impl<RealType> AbsoluteTolerance<RealType>

pub fn into_inner(self) -> RealType

Consumes the struct and returns the inner value.

impl<RealType: RealScalar> AbsoluteTolerance<RealType>

pub fn zero() -> Self

Creates an absolute tolerance of zero.

A zero tolerance represents an exact comparison (no error allowed).

Examples

use num_valid::scalars::AbsoluteTolerance;

let zero_tol = AbsoluteTolerance::<f64>::zero();
assert_eq!(*zero_tol.as_ref(), 0.0);

pub fn epsilon() -> Self

Creates an absolute tolerance equal to machine epsilon.

Machine epsilon is the smallest value such that 1.0 + epsilon != 1.0. This is often a good default tolerance for floating-point comparisons.

Examples

use num_valid::scalars::AbsoluteTolerance;

let eps_tol = AbsoluteTolerance::<f64>::epsilon();
assert_eq!(*eps_tol.as_ref(), f64::EPSILON);

Trait Implementations

impl<RealType> AsRef<RealType> for AbsoluteTolerance<RealType>

fn as_ref(&self) -> &RealType

Converts this type into a shared reference of the (usually inferred) input type.

impl<RealType: Clone> Clone for AbsoluteTolerance<RealType>

fn clone(&self) -> AbsoluteTolerance<RealType>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<RealType: Debug> Debug for AbsoluteTolerance<RealType>

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

Formats the value using the given formatter.

impl<'de, RealType> Deserialize<'de> for AbsoluteTolerance<RealType>

where RealType: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<RealType> Display for AbsoluteTolerance<RealType>

where RealType: Display,

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

Formats the value using the given formatter.

impl<RealType> IntoInner for AbsoluteTolerance<RealType>

fn into_inner(self) -> Self::InnerType

Consumes the struct and returns the inner value.

type InnerType = RealType

The type of the inner value that will be extracted.

impl<RealType> LowerExp for AbsoluteTolerance<RealType>

where RealType: LowerExp,

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

Formats the value using the given formatter.

impl<RealType: PartialEq> PartialEq for AbsoluteTolerance<RealType>

fn eq(&self, other: &AbsoluteTolerance<RealType>) -> 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<RealType: PartialOrd> PartialOrd for AbsoluteTolerance<RealType>

fn partial_cmp(&self, other: &AbsoluteTolerance<RealType>) -> 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<RealType> Serialize for AbsoluteTolerance<RealType>

where RealType: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<RealType: RealScalar> TryNew for AbsoluteTolerance<RealType>

fn try_new(value: RealType) -> Result<Self, Self::Error>

Attempts to create an AbsoluteTolerance from a value.

Errors

Returns ErrorsTolerance::NegativeValue if the input is negative.

Panics (Debug Mode Only)

In debug builds, panics if the input is not finite (NaN or infinity).

Examples

use num_valid::scalars::{AbsoluteTolerance, ErrorsTolerance};
use try_create::TryNew;

// Valid tolerances
assert!(AbsoluteTolerance::try_new(1e-10_f64).is_ok());
assert!(AbsoluteTolerance::try_new(0.0_f64).is_ok());

// Invalid (negative)
assert!(matches!(
    AbsoluteTolerance::try_new(-1e-10_f64),
    Err(ErrorsTolerance::NegativeValue { .. })
));

type Error = ErrorsTolerance<RealType>

The error type that can be returned by the try_new method.

impl<RealType> StructuralPartialEq for AbsoluteTolerance<RealType>