PARTONS/NumA++  
Numerical Analysis C++ routines
Public Member Functions | Private Member Functions | Private Attributes | List of all members
NumA::Tolerances Class Reference

Define absolute and relative tolerances for comparison of real numbers (double) and check if they are positive. More...

Public Member Functions

 Tolerances ()
 Default constructor (tolerances equal to 0). More...
 
 Tolerances (double absoluteTolerance, double relativeTolerance)
 Constructor. More...
 
virtual ~Tolerances ()
 Default destructor. More...
 
std::string toString () const
 
double getAbsoluteTolerance () const
 
double getRelativeTolerance () const
 
void setAbsoluteTolerance (double absoluteTolerance)
 
void setRelativeTolerance (double relativeTolerance)
 

Private Member Functions

void testPositivity (const double &tolerance) const
 Positivity test. More...
 

Private Attributes

double m_absoluteTolerance
 Absolute tolerance. More...
 
double m_relativeTolerance
 Relative tolerance. More...
 

Detailed Description

Define absolute and relative tolerances for comparison of real numbers (double) and check if they are positive.

Constructor & Destructor Documentation

◆ Tolerances() [1/2]

NumA::Tolerances::Tolerances ( )

Default constructor (tolerances equal to 0).

◆ Tolerances() [2/2]

NumA::Tolerances::Tolerances ( double  absoluteTolerance,
double  relativeTolerance 
)

Constructor.

Parameters
absoluteToleranceAbsolute tolerance.
relativeToleranceRelative tolerance.

◆ ~Tolerances()

NumA::Tolerances::~Tolerances ( )
virtual

Default destructor.

Member Function Documentation

◆ getAbsoluteTolerance()

double NumA::Tolerances::getAbsoluteTolerance ( ) const
Returns
Absolute tolerance.

◆ getRelativeTolerance()

double NumA::Tolerances::getRelativeTolerance ( ) const
Returns
Relative tolerance.

◆ setAbsoluteTolerance()

void NumA::Tolerances::setAbsoluteTolerance ( double  absoluteTolerance)
Parameters
absoluteToleranceAbsolute tolerance.

◆ setRelativeTolerance()

void NumA::Tolerances::setRelativeTolerance ( double  relativeTolerance)
Parameters
relativeToleranceRelative tolerance.

◆ testPositivity()

void NumA::Tolerances::testPositivity ( const double &  tolerance) const
private

Positivity test.

◆ toString()

std::string NumA::Tolerances::toString ( ) const
Returns
Pre-formatted string with the tolerances.

Member Data Documentation

◆ m_absoluteTolerance

double NumA::Tolerances::m_absoluteTolerance
private

Absolute tolerance.

◆ m_relativeTolerance

double NumA::Tolerances::m_relativeTolerance
private

Relative tolerance.


The documentation for this class was generated from the following files: