src/gromacs/random/tests/exponentialdistribution.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,2018, 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 /*! \internal \file
  36  * \brief Tests for GROMACS exponential distribution
  37  *
  38  * \author Erik Lindahl <erik.lindahl@gmail.com>
  39  * \ingroup module_random
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "gromacs/random/exponentialdistribution.h"
  44
  45 #include <gtest/gtest.h>
  46
  47 #include "gromacs/random/threefry.h"
  48
  49 #include "testutils/refdata.h"
  50 #include "testutils/testasserts.h"
  51
  52 namespace gmx
  53 {
  54
  55 namespace
  56 {
  57
  58 TEST(ExponentialDistributionTest, Output)
  59 {
  60     gmx::test::TestReferenceData        data;
  61     gmx::test::TestReferenceChecker     checker(data.rootChecker());
  62
  63     gmx::ThreeFry2x64<8>                rng(123456, gmx::RandomDomain::Other);
  64     gmx::ExponentialDistribution<real>  dist(5.0);
  65     std::vector<real>                   result;
  66
  67     result.reserve(10);
  68     for (int i = 0; i < 10; i++)
  69     {
  70         result.push_back(dist(rng));
  71     }
  72
  73     // The implementation of the exponential distribution both in GROMACS and all current C++
  74     // standard libraries tested is fragile since it computes an intermediate value by subtracting
  75     // a random number in [0,1) from 1.0. This should not affect the accuracy of the final distribution,
  76     // but depending on the compiler optimization individual values will show a somewhat larger
  77     // fluctuation compared to the other distributions.
  78     checker.setDefaultTolerance(gmx::test::relativeToleranceAsFloatingPoint(1.0, 1e-6));
  79     checker.checkSequence(result.begin(), result.end(), "ExponentialDistribution");
  80 }
  81
  82
  83 TEST(ExponentialDistributionTest, Logical)
  84 {
  85     gmx::ThreeFry2x64<8>                rng(123456, gmx::RandomDomain::Other);
  86     gmx::ExponentialDistribution<real>  distA(2.0);
  87     gmx::ExponentialDistribution<real>  distB(2.0);
  88     gmx::ExponentialDistribution<real>  distC(3.0);
  89
  90     EXPECT_EQ(distA, distB);
  91     EXPECT_NE(distA, distC);
  92 }
  93
  94
  95 TEST(ExponentialDistributionTest, Reset)
  96 {
  97     gmx::ThreeFry2x64<8>                                rng(123456, gmx::RandomDomain::Other);
  98     gmx::ExponentialDistribution<real>                  distA(2.0);
  99     gmx::ExponentialDistribution<real>                  distB(2.0);
 100     gmx::ExponentialDistribution<>::result_type         valA, valB;
 101
 102     valA = distA(rng);
 103
 104     distB(rng);
 105     rng.restart();
 106     distB.reset();
 107
 108     valB = distB(rng);
 109
 110     EXPECT_REAL_EQ_TOL(valA, valB, gmx::test::ulpTolerance(0));
 111 }
 112
 113 TEST(ExponentialDistributionTest, AltParam)
 114 {
 115     gmx::ThreeFry2x64<8>                            rngA(123456, gmx::RandomDomain::Other);
 116     gmx::ThreeFry2x64<8>                            rngB(123456, gmx::RandomDomain::Other);
 117     gmx::ExponentialDistribution<real>              distA(2.0);
 118     gmx::ExponentialDistribution<real>              distB; // default parameters
 119     gmx::ExponentialDistribution<real>::param_type  paramA(2.0);
 120
 121     EXPECT_NE(distA(rngA), distB(rngB));
 122     rngA.restart();
 123     rngB.restart();
 124     distA.reset();
 125     distB.reset();
 126     EXPECT_REAL_EQ_TOL(distA(rngA), distB(rngB, paramA), gmx::test::ulpTolerance(0));
 127 }
 128
 129 }  // namespace
 130
 131 }  // namespace gmx