TypeIIRMLMath.h

Go to the documentation of this file.

//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
//   For a convenient reading of this file's source code,
//   please use a tab width of four characters.
//  ----------------------------------------------------------


#ifndef __TypeIIRMLMath__
#define __TypeIIRMLMath__


//*******************************************************************************************
// Include files

#include <math.h>


namespace TypeIIRMLMath
{

//*******************************************************************************************
// Definitions and macros




//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define OTG_INFINITY ((double)1.0e100)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define RML_INPUT_VALUE_EPSILON ((double)1.0e-10)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define RML_VALID_SOLUTION_EPSILON ((double)1.0e-10)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define MAXIMAL_NO_OF_POLYNOMIALS  7


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define RML_MAX_EXECUTION_TIME ((double)1e10)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define RML_ADDITIONAL_RELATIVE_POSITION_ERROR_IN_CASE_OF_EQUALITY ((double)1e-7)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define RML_ADDITIONAL_ABSOLUTE_POSITION_ERROR_IN_CASE_OF_EQUALITY ((double)1e-7)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define POSITIVE_ZERO ((double)1.0e-50)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define ABSOLUTE_PHASE_SYNC_EPSILON ((double)1.0e-6)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define RELATIVE_PHASE_SYNC_EPSILON ((double)1.0e-3)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define RML_INFINITY ((double)1.0e100)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define RML_POSITION_EXTREMS_TIME_EPSILON ((double)1.0e-4)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define PHASE_SYNC_COLLINEARITY_REL_EPSILON ((double)1.0e-2)


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define Sign(A) ( ((double)(A) < 0.0)?(-1):(1) )


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define FSign(A) ( ((double)(A) < 0.0)?(-1.0):(1.0) )


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define pow2(A)                         ((A)*(A))


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
inline double RMLSqrt(const double &Value)
{
    return( ( Value <= 0.0 ) ? ( POSITIVE_ZERO ) : ( sqrt( Value ) ) );
}


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
#define IsInputEpsilonEqual(A,B) ((bool)((fabs((double)A - (double)B) <= RML_INPUT_VALUE_EPSILON)?(true):(false)))


//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
inline bool IsEpsilonEquality(      const double &Value1
                                ,   const double &Value2
                                ,   const double &Epsilon)
{
    return(fabs(Value1 - Value2) <= Epsilon);
}


}   // namespace TypeIIRMLMath

#endif