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, 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 "utilities.h"
  41
  42 #include "config.h"
  43
  44 #include <cassert>
  45 #include <climits>
  46 #include <cmath>
  47
  48 #include <algorithm>
  49 #include <cfenv>
  50
  51 //! Floating point exception set that we use and care about
  52 constexpr int c_FPexceptions = FE_DIVBYZERO | FE_INVALID | FE_OVERFLOW;
  53
  54 bool gmx_within_tol(double f1, double f2, double tol)
  55 {
  56     /* The or-equal is important - otherwise we return false if f1==f2==0 */
  57     return fabs(f1 - f2) <= tol * 0.5 * (fabs(f1) + fabs(f2));
  58 }
  59
  60 bool gmx_numzero(double a)
  61 {
  62     return gmx_within_tol(a, 0.0, GMX_REAL_MIN / GMX_REAL_EPS);
  63 }
  64
  65
  66 gmx_bool check_int_multiply_for_overflow(int64_t a, int64_t b, int64_t* result)
  67 {
  68     int64_t sign = 1;
  69     if ((0 == a) || (0 == b))
  70     {
  71         *result = 0;
  72         return TRUE;
  73     }
  74     if (a < 0)
  75     {
  76         a    = -a;
  77         sign = -sign;
  78     }
  79     if (b < 0)
  80     {
  81         b    = -b;
  82         sign = -sign;
  83     }
  84     if (INT64_MAX / b < a)
  85     {
  86         *result = (sign > 0) ? INT64_MAX : INT64_MIN;
  87         return FALSE;
  88     }
  89     *result = sign * a * b;
  90     return TRUE;
  91 }
  92
  93 int gmx_feenableexcept()
  94 {
  95 #if HAVE_FEENABLEEXCEPT
  96     return feenableexcept(c_FPexceptions);
  97 #elif (defined(__i386__) || defined(__x86_64__)) && defined(__APPLE__)
  98     /* Author:  David N. Williams
  99      * License:  Public Domain
 100      *
 101      * Might also work on non-Apple Unix. But should be tested
 102      * before enabling.
 103      */
 104     static fenv_t fenv;
 105     unsigned int  new_excepts = c_FPexceptions & FE_ALL_EXCEPT;
 106
 107     if (fegetenv(&fenv))
 108     {
 109         return -1;
 110     }
 111
 112     // unmask
 113     fenv.__control &= ~new_excepts;
 114     fenv.__mxcsr &= ~(new_excepts << 7);
 115
 116     return fesetenv(&fenv);
 117 #else
 118     return -1;
 119 #endif
 120 }
 121
 122 int gmx_fedisableexcept()
 123 {
 124 #if HAVE_FEDISABLEEXCEPT
 125     return fedisableexcept(c_FPexceptions);
 126 #elif (defined(__i386__) || defined(__x86_64__)) && defined(__APPLE__)
 127     static fenv_t fenv;
 128     unsigned int  new_excepts = c_FPexceptions & FE_ALL_EXCEPT;
 129     if (fegetenv(&fenv))
 130     {
 131         return -1;
 132     }
 133
 134     // mask
 135     fenv.__control |= new_excepts;
 136     fenv.__mxcsr |= new_excepts << 7;
 137
 138     return fesetenv(&fenv);
 139 #else
 140     return -1;
 141 #endif
 142 }