Struct AbsoluteTolerance 

pub struct AbsoluteTolerance<RealType: RealScalar>(/* 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.

Implementation

This type is a #[repr(transparent)] wrapper around NonNegativeRealScalar<T>. All validation is performed by the underlying NonNegativeRealScalar, and errors are reported as ErrorsNonNegativeRealScalar.

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};

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

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

In Numerical Comparisons

use num_valid::{*, scalars::*};
use try_create::{IntoInner, TryNew};

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: RealScalar> AbsoluteTolerance<RealType>

pub fn into_inner(self) -> NonNegativeRealScalar<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_raw_scalar_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_raw_scalar_ref(), &f64::EPSILON);

pub fn new(value: NonNegativeRealScalar<RealType>) -> Self

Wraps a NonNegativeRealScalar<T> as an AbsoluteTolerance<T>.

This constructor allows explicit conversion from a validated non-negative scalar to a tolerance type, providing semantic clarity.

Examples

use num_valid::{*, scalars::*};
use try_create::TryNew;

let non_neg = NonNegativeRealScalar::try_new(1e-10_f64).unwrap();
let tol = AbsoluteTolerance::new(non_neg);
assert_eq!(tol.as_raw_scalar_ref(), &1e-10);

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

Attempts to create a AbsoluteTolerance from a value.

Errors

Returns ErrorsNonNegativeRealScalar::NegativeValue if the input is negative.

Panics (Debug Mode Only)

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

Trait Implementations

impl<RealType: RealScalar> AsRef<NonNegativeRealScalar<RealType>> for AbsoluteTolerance<RealType>

fn as_ref(&self) -> &NonNegativeRealScalar<RealType>

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

impl<RealType: Clone + RealScalar> 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 + RealScalar> 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: for<'a> Deserialize<'a> + RealScalar,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

where NonNegativeRealScalar<RealType>: Display,

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

Formats the value using the given formatter.

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

fn into_inner(self) -> Self::InnerType

Consumes the struct and returns the inner value.

type InnerType = NonNegativeRealScalar<RealType>

The type of the inner value that will be extracted.

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

where NonNegativeRealScalar<RealType>: LowerExp,

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

Formats the value using the given formatter.

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

fn eq(&self, other: &AbsoluteTolerance<RealType>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<RealType: PartialOrd + RealScalar> 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: RealScalar> ScalarCore for AbsoluteTolerance<RealType>

type RawScalarType = <RealType as ScalarCore>::RawScalarType

The type of the inner value that will be extracted.

fn as_raw_scalar_ref(&self) -> &Self::RawScalarType

Returns a reference to the inner value.

fn into_raw_scalar(self) -> Self::RawScalarType

Consumes the scalar and returns its inner raw scalar value.

fn eq_raw(&self, other: &Self::RawScalarType) -> bool

Compares this scalar with a value in its underlying raw representation.

impl<RealType> Serialize for AbsoluteTolerance<RealType>

where RealType: Serialize + RealScalar,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<RealType: PartialEq + RealScalar> StructuralPartialEq for AbsoluteTolerance<RealType>