src/gromacs/random/uniformrealdistribution.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,2018,2019,2020, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35
  36 /*! \file
  37  * \brief The uniform real distribution
  38  *
  39  * Portable version of the uniform real that generates the same sequence
  40  * on all platforms. Since stdlibc++ and libc++ provide different sequences
  41  * we prefer this one so unit tests produce the same values on all platforms.
  42  *
  43  * \author Erik Lindahl <erik.lindahl@gmail.com>
  44  * \inpublicapi
  45  * \ingroup module_random
  46  */
  47
  48 #ifndef GMX_RANDOM_UNIFORMREALDISTRIBUTION_H
  49 #define GMX_RANDOM_UNIFORMREALDISTRIBUTION_H
  50
  51 #include <cmath>
  52
  53 #include <algorithm>
  54 #include <limits>
  55 #include <type_traits>
  56
  57 #include "gromacs/math/functions.h"
  58 #include "gromacs/utility/basedefinitions.h"
  59 #include "gromacs/utility/classhelpers.h"
  60 #include "gromacs/utility/gmxassert.h"
  61 #include "gromacs/utility/real.h"
  62
  63 /*
  64  * The portable version of the uniform real distribution (to make sure we get
  65  * the same values on all platforms) has been modified from the LLVM libcxx
  66  * headers, distributed under the MIT license:
  67  *
  68  * Copyright (c) The LLVM compiler infrastructure
  69  *
  70  * Permission is hereby granted, free of charge, to any person obtaining a copy
  71  * of this software and associated documentation files (the "Software"), to deal
  72  * in the Software without restriction, including without limitation the rights
  73  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  74  * copies of the Software, and to permit persons to whom the Software is
  75  * furnished to do so, subject to the following conditions:
  76  *
  77  * The above copyright notice and this permission notice shall be included in
  78  * all copies or substantial portions of the Software.
  79  *
  80  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  81  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  82  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  83  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  84  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  85  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  86  * THE SOFTWARE.
  87  */
  88
  89 namespace gmx
  90 {
  91
  92 /*! \brief Generate a floating-point value with specified number of random bits
  93  *
  94  * \tparam RealType  Floating-point type to generate
  95  * \tparam Bits      Number of random bits to generate
  96  * \tparam Rng       Random number generator class
  97  *
  98  * \param  g         Random number generator to use
  99  *
 100  * This implementation avoids the bug in libc++ and stdlibc++ (which is due
 101  * to the C++ standard being unclear) where 1.0 can be returned occasionally.
 102  *
 103  */
 104 template<class RealType = real, unsigned int Bits, class Rng>
 105 RealType generateCanonical(Rng& g)
 106 {
 107     // No point in using more bits than fit in RealType
 108     const uint64_t digits   = std::numeric_limits<RealType>::digits;
 109     const uint64_t realBits = std::min(digits, static_cast<uint64_t>(Bits));
 110     const uint64_t log2R    = std::numeric_limits<typename Rng::result_type>::digits;
 111     uint64_t       k        = realBits / log2R + (realBits % log2R != 0) + (realBits == 0);
 112     // Note that Rng::max and Rng::min are typically an integer type.
 113     // Only unsigned integer types can express the range using the
 114     // same type. Converting to RealType before computing the range
 115     // would work but we have no need for that.
 116     static_assert(std::is_unsigned_v<decltype(Rng::max())> && std::is_unsigned_v<decltype(Rng::min())>,
 117                   "Rng::max and Rng::min must be unsigned");
 118     RealType r    = RealType(Rng::max() - Rng::min()) + RealType(1);
 119     RealType s    = g() - Rng::min();
 120     RealType base = r;
 121     RealType result;
 122
 123     for (uint64_t i = 1; i < k; ++i)
 124     {
 125         s += RealType(g() - Rng::min()) * base;
 126         base *= r;
 127     }
 128     result = s / base;
 129
 130     // This implementation is specified by the C++ standard, but unfortunately it
 131     // has a bug where 1.0 can be generated occasionally due to the limited
 132     // precision of floating point, while 0.0 is only generated half as often as
 133     // it should. We "solve" both these issues by swapping 1.0 for 0.0 when it happens.
 134     //
 135     // See:
 136     // https://llvm.org/bugs/show_bug.cgi?id=18767
 137     // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=63176
 138     //
 139     // Note that we prefer not to use the gcc 'fix' of looping until the result
 140     // is smaller than 1.0, since that breaks the strict specification of the
 141     // number of times the rng will be called.
 142     //
 143     // This can only happen when we ask for the same number of bits that fit
 144     // in RealType, so by checking for that we avoid the extra code in all other
 145     // cases. If you are worried about it: Use RealType=double with 32 bits.
 146     //
 147     if (realBits == digits && result == 1.0)
 148     {
 149         result = 0.0;
 150     }
 151     return result;
 152 }
 153
 154
 155 /*! \brief Uniform real distribution
 156  *
 157  *  The C++ standard library does provide this distribution, but even
 158  *  though they all sample from the correct distribution different standard
 159  *  library implementations appear to return different sequences of numbers
 160  *  for the same random number generator. To make it easier to use GROMACS
 161  *  unit tests that depend on random numbers we have our own implementation.
 162  *
 163  * \tparam RealType Floating-point type, real by default in GROMACS.
 164  */
 165 template<class RealType = real>
 166 class UniformRealDistribution
 167 {
 168 public:
 169     /*! \brief Type of values returned */
 170     typedef RealType result_type;
 171
 172     /*! \brief Uniform real distribution parameters */
 173     class param_type
 174     {
 175         /*! \brief Lower end of range (inclusive) */
 176         result_type a_;
 177         /*! \brief Upper end of range (exclusive) */
 178         result_type b_;
 179
 180     public:
 181         /*! \brief Reference back to the distribution class */
 182         typedef UniformRealDistribution distribution_type;
 183
 184         /*! \brief Construct parameter block
 185          *
 186          * \param a   Lower end of range (inclusive)
 187          * \param b   Upper end of range (exclusive)
 188          */
 189         explicit param_type(result_type a = 0.0, result_type b = 1.0) : a_(a), b_(b)
 190         {
 191             GMX_RELEASE_ASSERT(a < b, "The uniform real distribution requires a<b");
 192         }
 193
 194         /*! \brief Return first parameter */
 195         result_type a() const { return a_; }
 196         /*! \brief Return second parameter */
 197         result_type b() const { return b_; }
 198
 199         /*! \brief True if two parameter sets will return the same uniform real distribution.
 200          *
 201          * \param x  Instance to compare with.
 202          */
 203         bool operator==(const param_type& x) const { return a_ == x.a_ && b_ == x.b_; }
 204
 205         /*! \brief True if two parameter sets will return different uniform real distributions
 206          *
 207          * \param x  Instance to compare with.
 208          */
 209         bool operator!=(const param_type& x) const { return !operator==(x); }
 210     };
 211
 212 public:
 213     /*! \brief Construct new distribution with given floating-point parameters.
 214      *
 215      * \param a   Lower end of range (inclusive)
 216      * \param b   Upper end of range (exclusive)
 217      */
 218     explicit UniformRealDistribution(result_type a = 0.0, result_type b = 1.0) :
 219         param_(param_type(a, b))
 220     {
 221     }
 222
 223     /*! \brief Construct new distribution from parameter class
 224      *
 225      * \param param  Parameter class as defined inside gmx::UniformRealDistribution.
 226      */
 227     explicit UniformRealDistribution(const param_type& param) : param_(param) {}
 228
 229     /*! \brief Flush all internal saved values  */
 230     void reset() {}
 231
 232     /*! \brief Return values from uniform real distribution with internal parameters
 233      *
 234      * \tparam Rng  Random engine class
 235      *
 236      * \param  g    Random engine
 237      */
 238     template<class Rng>
 239     result_type operator()(Rng& g)
 240     {
 241         return (*this)(g, param_);
 242     }
 243
 244     /*! \brief Return value from uniform real distribution with given parameters
 245      *
 246      * \tparam Rng   Random engine class
 247      *
 248      * \param  g     Random engine
 249      * \param  param Parameters to use
 250      */
 251     template<class Rng>
 252     result_type operator()(Rng& g, const param_type& param)
 253     {
 254         result_type r = generateCanonical<RealType, std::numeric_limits<RealType>::digits>(g);
 255         return (param.b() - param.a()) * r + param.a();
 256     }
 257
 258     /*! \brief Return the lower range uniform real distribution */
 259     result_type a() const { return param_.a(); }
 260
 261     /*! \brief Return the upper range of the uniform real distribution */
 262     result_type b() const { return param_.b(); }
 263
 264     /*! \brief Return the full parameter class of the uniform real distribution */
 265     param_type param() const { return param_; }
 266
 267     /*! \brief Smallest value that can be returned from uniform real distribution */
 268     result_type min() const { return a(); }
 269
 270     /*! \brief Largest value that can be returned from uniform real distribution */
 271     result_type max() const { return b(); }
 272
 273     /*! \brief True if two uniform real distributions will produce the same values.
 274      *
 275      * \param  x     Instance to compare with.
 276      */
 277     bool operator==(const UniformRealDistribution& x) const { return param_ == x.param_; }
 278
 279     /*! \brief True if two uniform real distributions will produce different values.
 280      *
 281      * \param  x     Instance to compare with.
 282      */
 283     bool operator!=(const UniformRealDistribution& x) const { return !operator==(x); }
 284
 285 private:
 286     /*! \brief Internal value for parameters, can be overridden at generation time. */
 287     param_type param_;
 288
 289     GMX_DISALLOW_COPY_AND_ASSIGN(UniformRealDistribution);
 290 };
 291
 292 } // namespace gmx
 293
 294 #endif // GMX_RANDOM_UNIFORMREALDISTRIBUTION_H