src/gromacs/legacyheaders/maths.h

   1 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
   2  *
   3  *
   4  *                This source code is part of
   5  *
   6  *                 G   R   O   M   A   C   S
   7  *
   8  *          GROningen MAchine for Chemical Simulations
   9  *
  10  *                        VERSION 3.2.0
  11  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  12  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  13  * Copyright (c) 2001-2004, The GROMACS development team,
  14  * check out http://www.gromacs.org for more information.
  15
  16  * This program is free software; you can redistribute it and/or
  17  * modify it under the terms of the GNU General Public License
  18  * as published by the Free Software Foundation; either version 2
  19  * of the License, or (at your option) any later version.
  20  *
  21  * If you want to redistribute modifications, please consider that
  22  * scientific software is very special. Version control is crucial -
  23  * bugs must be traceable. We will be happy to consider code for
  24  * inclusion in the official distribution, but derived work must not
  25  * be called official GROMACS. Details are found in the README & COPYING
  26  * files - if they are missing, get the official version at www.gromacs.org.
  27  *
  28  * To help us fund GROMACS development, we humbly ask that you cite
  29  * the papers on the package - you can find them in the top README file.
  30  *
  31  * For more info, check our website at http://www.gromacs.org
  32  *
  33  * And Hey:
  34  * Gromacs Runs On Most of All Computer Systems
  35  */
  36
  37 #ifndef _maths_h
  38 #define _maths_h
  39
  40 #include <math.h>
  41 #include "types/simple.h"
  42 #include "typedefs.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #ifndef M_PI
  49 #define M_PI        3.14159265358979323846
  50 #endif
  51
  52 #ifndef M_PI_2
  53 #define M_PI_2      1.57079632679489661923
  54 #endif
  55
  56 #ifndef M_2PI
  57 #define M_2PI       6.28318530717958647692
  58 #endif
  59
  60 #ifndef M_SQRT2
  61 #define M_SQRT2 sqrt(2.0)
  62 #endif
  63
  64 #ifndef M_1_PI
  65 #define M_1_PI      0.31830988618379067154
  66 #endif
  67
  68 #ifndef M_FLOAT_1_SQRTPI /* used in CUDA kernels */
  69 /* 1.0 / sqrt(M_PI) */
  70 #define M_FLOAT_1_SQRTPI 0.564189583547756f
  71 #endif
  72
  73 #ifndef M_1_SQRTPI
  74 /* 1.0 / sqrt(M_PI) */
  75 #define M_1_SQRTPI 0.564189583547756
  76 #endif
  77
  78 #ifndef M_2_SQRTPI
  79 /* 2.0 / sqrt(M_PI) */
  80 #define M_2_SQRTPI  1.128379167095513
  81 #endif
  82
  83 int     gmx_nint(real a);
  84 real    sign(real x, real y);
  85
  86 real    cuberoot (real a);
  87 double  gmx_erfd(double x);
  88 double  gmx_erfcd(double x);
  89 float   gmx_erff(float x);
  90 float   gmx_erfcf(float x);
  91 #ifdef GMX_DOUBLE
  92 #define gmx_erf(x)   gmx_erfd(x)
  93 #define gmx_erfc(x)  gmx_erfcd(x)
  94 #else
  95 #define gmx_erf(x)   gmx_erff(x)
  96 #define gmx_erfc(x)  gmx_erfcf(x)
  97 #endif
  98
  99 gmx_bool gmx_isfinite(real x);
 100 gmx_bool gmx_isnan(real x);
 101
 102 /*! \brief Check if two numbers are within a tolerance
 103  *
 104  *  This routine checks if the relative difference between two numbers is
 105  *  approximately within the given tolerance, defined as
 106  *  fabs(f1-f2)<=tolerance*fabs(f1+f2).
 107  *
 108  *  To check if two floating-point numbers are almost identical, use this routine
 109  *  with the tolerance GMX_REAL_EPS, or GMX_DOUBLE_EPS if the check should be
 110  *  done in double regardless of Gromacs precision.
 111  *
 112  *  To check if two algorithms produce similar results you will normally need
 113  *  to relax the tolerance significantly since many operations (e.g. summation)
 114  *  accumulate floating point errors.
 115  *
 116  *  \param f1  First number to compare
 117  *  \param f2  Second number to compare
 118  *  \param tol Tolerance to use
 119  *
 120  *  \return 1 if the relative difference is within tolerance, 0 if not.
 121  */
 122 static int
 123 gmx_within_tol(double   f1,
 124                double   f2,
 125                double   tol)
 126 {
 127     /* The or-equal is important - otherwise we return false if f1==f2==0 */
 128     if (fabs(f1-f2) <= tol*0.5*(fabs(f1)+fabs(f2)) )
 129     {
 130         return 1;
 131     }
 132     else
 133     {
 134         return 0;
 135     }
 136 }
 137
 138
 139
 140 /**
 141  * Check if a number is smaller than some preset safe minimum
 142  * value, currently defined as GMX_REAL_MIN/GMX_REAL_EPS.
 143  *
 144  * If a number is smaller than this value we risk numerical overflow
 145  * if any number larger than 1.0/GMX_REAL_EPS is divided by it.
 146  *
 147  * \return 1  if 'almost' numerically zero, 0 otherwise.
 148  */
 149 static int
 150 gmx_numzero(double a)
 151 {
 152     return gmx_within_tol(a, 0.0, GMX_REAL_MIN/GMX_REAL_EPS);
 153 }
 154
 155
 156 static real
 157 gmx_log2(real x)
 158 {
 159     const real iclog2 = 1.0/log( 2.0 );
 160
 161     return log( x ) * iclog2;
 162 }
 163
 164 /*! /brief Multiply two large ints
 165  *
 166  *  Returns true when overflow did not occur.
 167  */
 168 gmx_bool
 169 check_int_multiply_for_overflow(gmx_large_int_t  a,
 170                                 gmx_large_int_t  b,
 171                                 gmx_large_int_t *result);
 172
 173 #ifdef __cplusplus
 174 }
 175 #endif
 176
 177 #endif  /* _maths_h */