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,2015,2016,2017,2018,2019, 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 <limits.h>
  41
  42 #include <cmath>
  43
  44 #include "gromacs/utility/basedefinitions.h"
  45 #include "gromacs/utility/real.h"
  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 GPU 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 /*! \brief Enum to select safe or highly unsafe (faster) math functions.
  83  *
  84  *  Normally all the Gromacs math functions should apply reasonable care with
  85  *  input arguments. While we do not necessarily adhere strictly to IEEE
  86  *  (in particular not for arguments that might result in NaN, inf, etc.), the
  87  *  functions should return reasonable values or e.g. clamp results to zero.
  88  *
  89  *  However, in a few cases where we are extremely performance-sensitive it
  90  *  makes sense to forego these checks too in cases where we know the exact
  91  *  properties if the input data, and we really need to save every cycle we can.
  92  *
  93  *  This class is typically used as a template parameter to such calls to enable
  94  *  the caller to select the level of aggressiveness. We should always use the
  95  *  safe alternative as the default value, and document carefully what might
  96  *  happen with the unsafe alternative.
  97  */
  98 enum class MathOptimization
  99 {
 100     Safe,  //!< Don't do unsafe optimizations. This should always be default.
 101     Unsafe //!< Allow optimizations that can be VERY dangerous for general code.
 102 };
 103
 104 /*! \brief Check if two numbers are within a tolerance
 105  *
 106  *  This routine checks if the relative difference between two numbers is
 107  *  approximately within the given tolerance, defined as
 108  *  fabs(f1-f2)<=tolerance*fabs(f1+f2).
 109  *
 110  *  To check if two floating-point numbers are almost identical, use this routine
 111  *  with the tolerance GMX_REAL_EPS, or GMX_DOUBLE_EPS if the check should be
 112  *  done in double regardless of Gromacs precision.
 113  *
 114  *  To check if two algorithms produce similar results you will normally need
 115  *  to relax the tolerance significantly since many operations (e.g. summation)
 116  *  accumulate floating point errors.
 117  *
 118  *  \param f1  First number to compare
 119  *  \param f2  Second number to compare
 120  *  \param tol Tolerance to use
 121  *
 122  *  \return 1 if the relative difference is within tolerance, 0 if not.
 123  */
 124 bool gmx_within_tol(double f1, double f2, 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 bool gmx_numzero(double a);
 136
 137 /*! \brief Multiply two large ints
 138  *
 139  * \return False iff overflow occurred
 140  */
 141 gmx_bool check_int_multiply_for_overflow(int64_t a, int64_t b, int64_t* result);
 142
 143 /*! \brief Find greatest common divisor of two numbers
 144  *
 145  * \return GCD of the two inputs
 146  */
 147 int gmx_greatest_common_divisor(int p, int q);
 148
 149
 150 /*! \brief Enable floating-point exceptions if supported on OS
 151  *
 152  * Enables division-by-zero, invalid value, and overflow.
 153  *
 154  * \returns 0 if successful in enabling exceptions, anything else in case of failure/unsupported OS.
 155  */
 156 int gmx_feenableexcept();
 157
 158 /*! \brief Disable floating-point exceptions if supported on OS
 159  *
 160  * Disables division-by-zero, invalid value, and overflow.
 161  *
 162  * \returns 0 if successful in disabling exceptions, anything else in case of failure/unsupported OS.
 163  */
 164 int gmx_fedisableexcept();
 165
 166 /*! \brief Return cut-off to use
 167  *
 168  * Takes the max of two cut-offs. However a cut-off of 0
 169  * signifies that the cut-off in fact is infinite, and
 170  * this requires this special routine.
 171  * \param[in] cutoff1 The first cutoff (e.g. coulomb)
 172  * \param[in] cutoff2 The second cutoff (e.g. vdw)
 173  * \return 0 if either is 0, the normal max of the two otherwise.
 174  */
 175 real max_cutoff(real cutoff1, real cutoff2);
 176
 177 #endif