src/gromacs/math/utilities.cpp

   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,2018 by the GROMACS development team.
   7  * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #include "gmxpre.h"
  39
  40 #include "gromacs/math/utilities.h"
  41 #include "gromacs/utility/real.h"
  42
  43 #include "config.h"
  44
  45 #include <cstdint>
  46 #include <cmath>
  47
  48 #include <cfenv>
  49
  50 //! Floating point exception set that we use and care about
  51 constexpr int c_FPexceptions = FE_DIVBYZERO | FE_INVALID | FE_OVERFLOW;
  52
  53 bool gmx_within_tol(double f1, double f2, double tol)
  54 {
  55     /* The or-equal is important - otherwise we return false if f1==f2==0 */
  56     return fabs(f1 - f2) <= tol * 0.5 * (fabs(f1) + fabs(f2));
  57 }
  58
  59 bool gmx_numzero(double a)
  60 {
  61     return gmx_within_tol(a, 0.0, GMX_REAL_MIN / GMX_REAL_EPS);
  62 }
  63
  64
  65 bool check_int_multiply_for_overflow(int64_t a, int64_t b, int64_t* result)
  66 {
  67     int64_t sign = 1;
  68     if ((0 == a) || (0 == b))
  69     {
  70         *result = 0;
  71         return true;
  72     }
  73     if (a < 0)
  74     {
  75         a    = -a;
  76         sign = -sign;
  77     }
  78     if (b < 0)
  79     {
  80         b    = -b;
  81         sign = -sign;
  82     }
  83     if (INT64_MAX / b < a)
  84     {
  85         *result = (sign > 0) ? INT64_MAX : INT64_MIN;
  86         return false;
  87     }
  88     *result = sign * a * b;
  89     return true;
  90 }
  91
  92 int gmx_feenableexcept()
  93 {
  94 #if HAVE_FEENABLEEXCEPT
  95     return feenableexcept(c_FPexceptions);
  96 #elif (defined(__i386__) || defined(__x86_64__)) && defined(__APPLE__)
  97     /* Author:  David N. Williams
  98      * License:  Public Domain
  99      *
 100      * Might also work on non-Apple Unix. But should be tested
 101      * before enabling.
 102      */
 103     static fenv_t fenv;
 104     unsigned int  new_excepts = c_FPexceptions & FE_ALL_EXCEPT;
 105
 106     if (fegetenv(&fenv))
 107     {
 108         return -1;
 109     }
 110
 111     // unmask
 112     fenv.__control &= ~new_excepts;
 113     fenv.__mxcsr &= ~(new_excepts << 7);
 114
 115     return fesetenv(&fenv);
 116 #else
 117     return -1;
 118 #endif
 119 }
 120
 121 int gmx_fedisableexcept()
 122 {
 123 #if HAVE_FEDISABLEEXCEPT
 124     return fedisableexcept(c_FPexceptions);
 125 #elif (defined(__i386__) || defined(__x86_64__)) && defined(__APPLE__)
 126     static fenv_t fenv;
 127     unsigned int  new_excepts = c_FPexceptions & FE_ALL_EXCEPT;
 128     if (fegetenv(&fenv))
 129     {
 130         return -1;
 131     }
 132
 133     // mask
 134     fenv.__control |= new_excepts;
 135     fenv.__mxcsr |= new_excepts << 7;
 136
 137     return fesetenv(&fenv);
 138 #else
 139     return -1;
 140 #endif
 141 }
 142
 143 bool gmxShouldEnableFPExceptions()
 144 {
 145 #if defined(NDEBUG)
 146     return false; // Release build
 147 #elif ((defined __clang__ || (defined(__GNUC__) && __GNUC__ == 7)) && defined __OPTIMIZE__)
 148     return false; // Buggy compiler
 149 #elif GMX_GPU_SYCL
 150     return false; // avoid spurious FPE during SYCL JIT
 151 #else
 152     return true;
 153 #endif
 154 }