numutil.h File Reference

#include <cmath>
#include <cfloat>
#include <limits>

Include dependency graph for numutil.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	M_E   2.7182818284590452353
#define	M_PI   3.14159265358979323846

Functions
bool	almostEqual (float x, float y, float epsilon=FLT_EPSILON)
bool	almostEqual (double x, double y, double epsilon=DBL_EPSILON)
bool	almostEqual (long double x, long double y, long double epsilon=LDBL_EPSILON)
template<class T >
bool	isClose (T a, T b, T tolerance)
template<typename T >
bool	isInfinity (T value)
template<class T >
bool	isNaN (T value)

Variables
const double	LN2 = 0.69314718055994528622676
const unsigned long	LN2BYTES = 0xB1721814
const double	NATURAL_E = 2.718281828459045
const int	WORD_LENGTH = 32

Macro Definition Documentation

#define M_E   2.7182818284590452353

Definition at line 38 of file numutil.h.

Referenced by Func::Func(), FuncTerm::FuncTerm(), Func::operator=(), and SeqSynHandler::updateKernel().

#define M_PI   3.14159265358979323846

Definition at line 34 of file numutil.h.

Referenced by ReadCell::addCaConc(), ReadCell::buildChannels(), ReadCell::buildCompartment(), calcSurf(), DifBuffer::calculateVolumeArea(), DifShell::calculateVolumeArea(), Func::Func(), FuncTerm::FuncTerm(), Func::operator=(), ReadCell::readData(), SeqSynHandler::updateKernel(), and DifBuffer::vReinit().

Function Documentation

bool almostEqual	(	float	x,
		float	y,
		float	epsilon = FLT_EPSILON
	)

Definition at line 27 of file numutil.cpp.

Referenced by Interpol::setXmax(), and Interpol::setXmin().

{
    if (x == 0.0 && y == 0.0) {
        return true;
    }

    if (fabs(x) > fabs(y)) {
        return fabs((x - y) / x) < epsilon;
    } else {
        return fabs((x - y) / y) < epsilon;
    }
}

Here is the caller graph for this function:

bool almostEqual	(	double	x,
		double	y,
		double	epsilon = DBL_EPSILON
	)

Definition at line 40 of file numutil.cpp.

{
    if (x == 0.0 && y == 0.0){
        return true;
    }
    if (fabs(x) > fabs(y)){
        return fabs((x - y) / x) < epsilon;
    } else {
        return fabs((x - y) / y) < epsilon;
    }
}

bool almostEqual	(	long double	x,
		long double	y,
		long double	epsilon = LDBL_EPSILON
	)

Definition at line 52 of file numutil.cpp.

{
    if (x == 0.0 && y == 0.0){
        return true;
    }
    if (std::fabs(x) > std::fabs(y)){
        return std::fabs((x - y) / x) < epsilon;
    } else {
        return std::fabs((x - y) / y) < epsilon;
    }
}

template<class T >

bool isClose	(	T	a,
		T	b,
		T	tolerance
	)

Check 2 floating-point numbers for "equality". Algorithm (from Knuth) 'a' and 'b' are close if: | ( a - b ) / a | < e AND | ( a - b ) / b | < e where 'e' is a small number.

In this function, 'e' is computed as: e = tolerance * machine-epsilon

Definition at line 67 of file numutil.h.

{
    T epsilon = std::numeric_limits< T >::epsilon();

    if ( a == b )
        return true;

    if ( a == 0 || b == 0 )
        return ( fabs( a - b ) < tolerance * epsilon );

    return (
            fabs( ( a - b ) / a ) < tolerance * epsilon
            &&
            fabs( ( a - b ) / b ) < tolerance * epsilon
           );
}

template<typename T >

bool isInfinity

(

T

value

)

Definition at line 52 of file numutil.h.

{
    return value == std::numeric_limits< T >::infinity();
}

template<class T >

bool isNaN

(

T

value

)

Functions for floating point comparisons

Definition at line 46 of file numutil.h.

References value.

{
    return value != value;
}

Variable Documentation

const double LN2 = 0.69314718055994528622676

Definition at line 26 of file numutil.h.

const unsigned long LN2BYTES = 0xB1721814

Definition at line 27 of file numutil.h.

const double NATURAL_E = 2.718281828459045

Definition at line 28 of file numutil.h.

const int WORD_LENGTH = 32

Definition at line 25 of file numutil.h.