src/gromacs/math/utilities.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_MATH_UTILITIES_H
  38 #define GMX_MATH_UTILITIES_H
  39
  40 #include "../legacyheaders/types/simple.h"
  41 #include <limits.h>
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #ifndef M_PI
  48 #define M_PI        3.14159265358979323846
  49 #endif
  50
  51 #ifndef M_PI_2
  52 #define M_PI_2      1.57079632679489661923
  53 #endif
  54
  55 #ifndef M_2PI
  56 #define M_2PI       6.28318530717958647692
  57 #endif
  58
  59 #ifndef M_SQRT2
  60 #define M_SQRT2 sqrt(2.0)
  61 #endif
  62
  63 #ifndef M_1_PI
  64 #define M_1_PI      0.31830988618379067154
  65 #endif
  66
  67 #ifndef M_FLOAT_1_SQRTPI /* used in CUDA kernels */
  68 /* 1.0 / sqrt(M_PI) */
  69 #define M_FLOAT_1_SQRTPI 0.564189583547756f
  70 #endif
  71
  72 #ifndef M_1_SQRTPI
  73 /* 1.0 / sqrt(M_PI) */
  74 #define M_1_SQRTPI 0.564189583547756
  75 #endif
  76
  77 #ifndef M_2_SQRTPI
  78 /* 2.0 / sqrt(M_PI) */
  79 #define M_2_SQRTPI  1.128379167095513
  80 #endif
  81
  82 int     gmx_nint(real a);
  83 real    sign(real x, real y);
  84
  85 real    cuberoot (real a);
  86 double  gmx_erfd(double x);
  87 double  gmx_erfcd(double x);
  88 float   gmx_erff(float x);
  89 float   gmx_erfcf(float x);
  90 #ifdef GMX_DOUBLE
  91 #define gmx_erf(x)   gmx_erfd(x)
  92 #define gmx_erfc(x)  gmx_erfcd(x)
  93 #else
  94 #define gmx_erf(x)   gmx_erff(x)
  95 #define gmx_erfc(x)  gmx_erfcf(x)
  96 #endif
  97
  98 gmx_bool gmx_isfinite(real x);
  99 gmx_bool gmx_isnan(real x);
 100
 101 /*! \brief Check if two numbers are within a tolerance
 102  *
 103  *  This routine checks if the relative difference between two numbers is
 104  *  approximately within the given tolerance, defined as
 105  *  fabs(f1-f2)<=tolerance*fabs(f1+f2).
 106  *
 107  *  To check if two floating-point numbers are almost identical, use this routine
 108  *  with the tolerance GMX_REAL_EPS, or GMX_DOUBLE_EPS if the check should be
 109  *  done in double regardless of Gromacs precision.
 110  *
 111  *  To check if two algorithms produce similar results you will normally need
 112  *  to relax the tolerance significantly since many operations (e.g. summation)
 113  *  accumulate floating point errors.
 114  *
 115  *  \param f1  First number to compare
 116  *  \param f2  Second number to compare
 117  *  \param tol Tolerance to use
 118  *
 119  *  \return 1 if the relative difference is within tolerance, 0 if not.
 120  */
 121 int
 122 gmx_within_tol(double   f1,
 123                double   f2,
 124                double   tol);
 125
 126 /*!
 127  * \brief Check if a number is smaller than some preset safe minimum
 128  * value, currently defined as GMX_REAL_MIN/GMX_REAL_EPS.
 129  *
 130  * If a number is smaller than this value we risk numerical overflow
 131  * if any number larger than 1.0/GMX_REAL_EPS is divided by it.
 132  *
 133  * \return 1  if 'almost' numerically zero, 0 otherwise.
 134  */
 135 int
 136 gmx_numzero(double a);
 137
 138 /*! \brief Compute floor of logarithm to base 2
 139  *
 140  * \return log2(x)
 141  */
 142 unsigned int
 143 gmx_log2i(unsigned int x);
 144
 145 /*! /brief Multiply two large ints
 146  *
 147  *  \return False iff overflow occured
 148  */
 149 gmx_bool
 150 check_int_multiply_for_overflow(gmx_int64_t  a,
 151                                 gmx_int64_t  b,
 152                                 gmx_int64_t *result);
 153
 154 /*! \brief Find greatest common divisor of two numbers
 155  *
 156  * \return GCD of the two inputs
 157  */
 158 int
 159 gmx_greatest_common_divisor(int p, int q);
 160
 161 #ifdef __cplusplus
 162 }
 163 #endif
 164
 165 #endif