src/gromacs/random/uniformintdistribution.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,2018,2019,2021, 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 integer distribution
  38  *
  39  * Portable version of the uniform integer 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_UNIFORMINTDISTRIBUTION_H
  49 #define GMX_RANDOM_UNIFORMINTDISTRIBUTION_H
  50
  51 #include <limits>
  52 #include <memory>
  53
  54 #include "gromacs/math/functions.h"
  55 #include "gromacs/utility/basedefinitions.h"
  56 #include "gromacs/utility/classhelpers.h"
  57 #include "gromacs/utility/gmxassert.h"
  58
  59 namespace gmx
  60 {
  61
  62 /*! \brief Uniform integer distribution
  63  *
  64  *  The C++ standard library does provide this distribution, but even
  65  *  though they all sample from the correct distribution different standard
  66  *  library implementations appear to return different sequences of numbers
  67  *  for the same random number generator. To make it easier to use GROMACS
  68  *  unit tests that depend on random numbers we have our own implementation.
  69  *
  70  * \tparam IntType Integer type, int by default.
  71  */
  72 template<class IntType = int>
  73 class UniformIntDistribution
  74 {
  75 public:
  76     /*! \brief Type of values returned */
  77     typedef IntType result_type;
  78
  79     /*! \brief Uniform int distribution parameters */
  80     class param_type
  81     {
  82         /*! \brief Lower end of range (inclusive) */
  83         result_type a_;
  84         /*! \brief Upper end of range (inclusive) */
  85         result_type b_;
  86
  87     public:
  88         /*! \brief Reference back to the distribution class */
  89         typedef UniformIntDistribution distribution_type;
  90
  91         /*! \brief Construct parameter block
  92          *
  93          * \param a   Lower end of range (inclusive)
  94          * \param b   Upper end of range (inclusive)
  95          */
  96         explicit param_type(result_type a = 0, result_type b = std::numeric_limits<result_type>::max()) :
  97             a_(a),
  98             b_(b)
  99         {
 100             GMX_RELEASE_ASSERT(a <= b, "The uniform integer distribution requires a<=b");
 101         }
 102
 103         /*! \brief Return lower range */
 104         result_type a() const { return a_; }
 105         /*! \brief Return upper range */
 106         result_type b() const { return b_; }
 107
 108         /*! \brief True if two parameter sets will return the same uniform int distribution.
 109          *
 110          * \param x  Instance to compare with.
 111          */
 112         bool operator==(const param_type& x) const
 113         {
 114             // rangeBits is a function of a & b, so it does not have to be tested
 115             return a_ == x.a_ && b_ == x.b_;
 116         }
 117
 118         /*! \brief True if two parameter sets will return different uniform int distributions
 119          *
 120          * \param x  Instance to compare with.
 121          */
 122         bool operator!=(const param_type& x) const { return !operator==(x); }
 123     };
 124
 125     /*! \brief Construct new distribution with given integer parameters.
 126      *
 127      * \param a   Lower end of range (inclusive)
 128      * \param b   Upper end of range (inclusive)
 129      */
 130     explicit UniformIntDistribution(result_type a = 0,
 131                                     result_type b = std::numeric_limits<result_type>::max()) :
 132         param_(param_type(a, b)),
 133         savedRandomBits_(0),
 134         savedRandomBitsLeft_(0)
 135     {
 136     }
 137
 138     /*! \brief Construct new distribution from parameter class
 139      *
 140      * \param param  Parameter class as defined inside gmx::UniformIntDistribution.
 141      */
 142     explicit UniformIntDistribution(const param_type& param) :
 143         param_(param),
 144         savedRandomBits_(0),
 145         savedRandomBitsLeft_(0)
 146     {
 147     }
 148
 149     /*! \brief Flush all internal saved values  */
 150     void reset() { savedRandomBitsLeft_ = 0; }
 151
 152     /*! \brief Return values from uniform int distribution with internal parameters
 153      *
 154      * \tparam Rng  Uniform random engine class
 155      *
 156      * \param  g    Random engine
 157      */
 158     template<class Rng>
 159     result_type operator()(Rng& g)
 160     {
 161         return (*this)(g, param_);
 162     }
 163
 164     /*! \brief Return value from uniform int distribution with given parameters
 165      *
 166      * \tparam Rng   Uniform random engine class
 167      *
 168      * \param  g     Random engine
 169      * \param  param Parameters to use
 170      */
 171     template<class Rng>
 172     result_type operator()(Rng& g, const param_type& param)
 173     {
 174         static_assert(sizeof(typename Rng::result_type) >= sizeof(uint32_t),
 175                       "The random engine result_type should be 32 or 64 bits");
 176
 177         result_type  range = param.b() - param.a();
 178         unsigned int rangeBits;
 179         result_type  result;
 180
 181         if (range == 0)
 182         {
 183             return param.a();
 184         }
 185         else if (range == std::numeric_limits<result_type>::max())
 186         {
 187             rangeBits = std::numeric_limits<result_type>::digits; // Use all bits in type
 188         }
 189         else
 190         {
 191             if (sizeof(result_type) == sizeof(uint32_t))
 192             {
 193                 rangeBits = log2I(static_cast<uint32_t>(range));
 194             }
 195             else
 196             {
 197                 rangeBits = log2I(range);
 198             }
 199             rangeBits += ((range >> rangeBits) > 0);
 200         }
 201
 202         do
 203         {
 204             if (savedRandomBitsLeft_ < rangeBits)
 205             {
 206                 savedRandomBits_     = static_cast<uint64_t>(g());
 207                 savedRandomBitsLeft_ = std::numeric_limits<typename Rng::result_type>::digits;
 208
 209                 if (sizeof(typename Rng::result_type) == sizeof(uint32_t))
 210                 {
 211                     savedRandomBits_ <<= std::numeric_limits<uint32_t>::digits;
 212                     savedRandomBits_ |= g();
 213                     savedRandomBitsLeft_ += std::numeric_limits<uint32_t>::digits;
 214                 }
 215             }
 216             result = savedRandomBits_;
 217             savedRandomBits_ >>= rangeBits;
 218             result = result - (savedRandomBits_ << rangeBits);
 219             savedRandomBitsLeft_ -= rangeBits;
 220         } while (result > range);
 221
 222         return result + param.a();
 223     }
 224
 225     /*! \brief Return the lower range uniform int distribution */
 226     result_type a() const { return param_.a(); }
 227
 228     /*! \brief Return the upper range of the uniform int distribution */
 229     result_type b() const { return param_.b(); }
 230
 231     /*! \brief Return the full parameter class of the uniform int distribution */
 232     param_type param() const { return param_; }
 233
 234     /*! \brief Smallest value that can be returned from uniform int distribution */
 235     result_type min() const { return a(); }
 236
 237     /*! \brief Largest value that can be returned from uniform int distribution */
 238     result_type max() const { return b(); }
 239
 240     /*! \brief True if two uniform int distributions will produce the same values.
 241      *
 242      * \param  x     Instance to compare with.
 243      */
 244     bool operator==(const UniformIntDistribution& x) const { return param_ == x.param_; }
 245
 246     /*! \brief True if two uniform int distributions will produce different values.
 247      *
 248      * \param  x     Instance to compare with.
 249      */
 250     bool operator!=(const UniformIntDistribution& x) const { return !operator==(x); }
 251
 252 private:
 253     /*! \brief Internal value for parameters, can be overridden at generation time. */
 254     param_type param_;
 255     /*! \brief Saved output from random engine, shifted tableBits right each time */
 256     uint64_t savedRandomBits_;
 257     /*! \brief Number of valid bits remaining i savedRandomBits_ */
 258     unsigned int savedRandomBitsLeft_;
 259
 260     GMX_DISALLOW_COPY_AND_ASSIGN(UniformIntDistribution);
 261 };
 262
 263 } // namespace gmx
 264
 265 #endif // GMX_RANDOM_UNIFORMINTDISTRIBUTION_H