Struct RelativeTolerance 

pub struct RelativeTolerance<RealType: RealScalar>(/* private fields */);

Type-safe wrapper for relative tolerance values.

RelativeTolerance<T> represents a non-negative (≥ 0) tolerance value used for relative (proportional) error comparisons. It can be converted to an absolute tolerance based on a reference value.

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

A relative tolerance ε_rel is used in comparisons like:

|a - b| ≤ ε_rel × |reference|

Common relative tolerances:

• 0.01 = 1% tolerance
• 0.001 = 0.1% tolerance
• 1e-6 = one part per million

Examples

Basic Usage

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

let one_percent = RelativeTolerance::try_new(0.01_f64).unwrap();
assert_eq!(*one_percent.as_raw_scalar_ref(), 0.01);

Converting to Absolute Tolerance

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

let rel_tol = RelativeTolerance::try_new(0.01_f64).unwrap(); // 1%

// Convert based on reference value
let abs_tol = rel_tol.absolute_tolerance(1000.0);
assert_eq!(*abs_tol.as_raw_scalar_ref(), 10.0); // 1% of 1000 = 10

// Works with negative references (uses absolute value)
let abs_tol_neg = rel_tol.absolute_tolerance(-500.0);
assert_eq!(*abs_tol_neg.as_raw_scalar_ref(), 5.0); // 1% of |-500| = 5

Implementations

impl<RealType: RealScalar> RelativeTolerance<RealType>

pub fn into_inner(self) -> NonNegativeRealScalar<RealType>

Consumes the struct and returns the inner value.

impl<RealType: RealScalar> RelativeTolerance<RealType>

pub fn zero() -> Self

Creates a relative tolerance of zero.

A zero relative tolerance represents an exact comparison.

Examples

use num_valid::{*, scalars::RelativeTolerance};

let zero_tol = RelativeTolerance::<f64>::zero();
assert_eq!(zero_tol.as_raw_scalar_ref(), &0.0);

pub fn epsilon() -> Self

Creates a relative tolerance equal to machine epsilon.

Examples

use num_valid::{*, scalars::RelativeTolerance};

let eps_tol = RelativeTolerance::<f64>::epsilon();
assert_eq!(eps_tol.as_raw_scalar_ref(), &f64::EPSILON);

pub fn absolute_tolerance( &self, reference: RealType, ) -> AbsoluteTolerance<RealType>

Converts this relative tolerance to an absolute tolerance based on a reference value.

The absolute tolerance is computed as:

absolute_tolerance = relative_tolerance × |reference|

Parameters

• reference: The reference value to scale by. The absolute value is used.

Examples

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

let rel_tol = RelativeTolerance::try_new(0.1_f64).unwrap(); // 10%

// 10% of 100 = 10
let abs_tol = rel_tol.absolute_tolerance(100.0);
assert_eq!(*abs_tol.as_raw_scalar_ref(), 10.0);

// 10% of |-50| = 5
let abs_tol_neg = rel_tol.absolute_tolerance(-50.0);
assert_eq!(*abs_tol_neg.as_raw_scalar_ref(), 5.0);

// 10% of 0 = 0
let abs_tol_zero = rel_tol.absolute_tolerance(0.0);
assert_eq!(*abs_tol_zero.as_raw_scalar_ref(), 0.0);

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

Wraps a NonNegativeRealScalar<T> as a RelativeTolerance<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(0.01_f64).unwrap(); // 1%
let tol = RelativeTolerance::new(non_neg);
assert_eq!(tol.as_raw_scalar_ref(), &0.01);

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

Attempts to create a RelativeTolerance 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 RelativeTolerance<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 RelativeTolerance<RealType>

fn clone(&self) -> RelativeTolerance<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 RelativeTolerance<RealType>

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

Formats the value using the given formatter.

impl<'de, RealType> Deserialize<'de> for RelativeTolerance<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 RelativeTolerance<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 RelativeTolerance<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 RelativeTolerance<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 RelativeTolerance<RealType>

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

Equality operator ==.

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

Inequality operator !=.

impl<RealType: PartialOrd + RealScalar> PartialOrd for RelativeTolerance<RealType>

fn partial_cmp(&self, other: &RelativeTolerance<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 RelativeTolerance<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 RelativeTolerance<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 RelativeTolerance<RealType>