Loading...
Searching...
No Matches
Public Member Functions | List of all members
bitpit::utils::DoubleFloatingLess Struct Reference

#include <commonUtils.hpp>

Inheritance diagram for bitpit::utils::DoubleFloatingLess:
Inheritance graph
[legend]
Collaboration diagram for bitpit::utils::DoubleFloatingLess:
Collaboration graph
[legend]

Public Member Functions

bool operator() (double x, double y, double relativeTolerance=DEFAULT_REL_TOL, double absoluteTolerance=DEFAULT_ABS_TOL) const
 

Additional Inherited Members

- Static Protected Attributes inherited from bitpit::utils::DoubleFloatingComparison
static constexpr const double DEFAULT_ABS_TOL = 10 * std::numeric_limits<double>::epsilon()
 
static constexpr const double DEFAULT_REL_TOL = 10 * std::numeric_limits<double>::epsilon()
 

Detailed Description

Functor to check if a floating point value compares less than another.

Definition at line 202 of file commonUtils.hpp.

Member Function Documentation

◆ operator()()

bool bitpit::utils::DoubleFloatingLess::operator() ( double x,
double y,
double relativeTolerance = DEFAULT_REL_TOL,
double absoluteTolerance = DEFAULT_ABS_TOL ) const
inline

Compares the specified double precision floating point numbers and returns true if the first value compare less than the second.

This is equaivalent to:

   (x < y) AND (NOT FloatingEqual(x, y))

where FloatingEqual is the operator that compares two double precision floating point numbers.

Parameters
xif the first value to compare
yif the second value to compare
relativeToleranceis the relative tolerance that will be used to perform the comparison
absoluteToleranceis the absolute tolerance that will be used to perform the comparison
Returns
Returns true if the first value compare less than the second, false otherwise.

Definition at line 224 of file commonUtils.hpp.


The documentation for this struct was generated from the following file:
--- layout: doxygen_footer ---