src/gromacs/random/tests/uniformrealdistribution.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 uniform real distribution
  37  *
  38  * \author Erik Lindahl <erik.lindahl@gmail.com>
  39  * \ingroup module_random
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "gromacs/random/uniformrealdistribution.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(UniformRealDistributionTest, GenerateCanonical)
  59 {
  60     gmx::test::TestReferenceData        data;
  61     gmx::test::TestReferenceChecker     checker(data.rootChecker());
  62
  63     gmx::ThreeFry2x64<8>                rng(123456, gmx::RandomDomain::Other);
  64     std::vector<real>                   result;
  65
  66     result.reserve(10);
  67     for (int i = 0; i < 10; i++)
  68     {
  69         result.push_back(gmx::generateCanonical<real, std::numeric_limits<real>::digits>(rng));
  70     }
  71     checker.checkSequence(result.begin(), result.end(), "GenerateCanonical");
  72 }
  73
  74 TEST(UniformRealDistributionTest, Output)
  75 {
  76     gmx::test::TestReferenceData            data;
  77     gmx::test::TestReferenceChecker         checker(data.rootChecker());
  78
  79     gmx::ThreeFry2x64<8>                    rng(123456, gmx::RandomDomain::Other);
  80     gmx::UniformRealDistribution<real>      dist(1.0, 10.0);
  81     std::vector<real>                       result;
  82
  83     result.reserve(10);
  84     for (int i = 0; i < 10; i++)
  85     {
  86         result.push_back(dist(rng));
  87     }
  88     checker.checkSequence(result.begin(), result.end(), "UniformRealDistribution");
  89 }
  90
  91 TEST(UniformRealDistributionTest, Logical)
  92 {
  93     gmx::ThreeFry2x64<8>                rng(123456, gmx::RandomDomain::Other);
  94     gmx::UniformRealDistribution<real>  distA(2.0, 5.0);
  95     gmx::UniformRealDistribution<real>  distB(2.0, 5.0);
  96     gmx::UniformRealDistribution<real>  distC(3.0, 5.0);
  97     gmx::UniformRealDistribution<real>  distD(2.0, 4.0);
  98
  99     EXPECT_EQ(distA, distB);
 100     EXPECT_NE(distA, distC);
 101     EXPECT_NE(distA, distD);
 102 }
 103
 104
 105 TEST(UniformRealDistributionTest, Reset)
 106 {
 107     gmx::ThreeFry2x64<8>                             rng(123456, gmx::RandomDomain::Other);
 108     gmx::UniformRealDistribution<real>               distA(2.0, 5.0);
 109     gmx::UniformRealDistribution<real>               distB(2.0, 5.0);
 110     gmx::UniformRealDistribution<real>::result_type  valA, valB;
 111
 112     valA = distA(rng);
 113
 114     distB(rng);
 115     rng.restart();
 116     distB.reset();
 117
 118     valB = distB(rng);
 119
 120     // Use floating-point test with no tolerance rather than exact
 121     // test, since the later fails with 32-bit gcc-4.8.4
 122     EXPECT_REAL_EQ_TOL(valA, valB, gmx::test::ulpTolerance(0));
 123 }
 124
 125 TEST(UniformRealDistributionTest, AltParam)
 126 {
 127     gmx::ThreeFry2x64<8>                            rngA(123456, gmx::RandomDomain::Other);
 128     gmx::ThreeFry2x64<8>                            rngB(123456, gmx::RandomDomain::Other);
 129     gmx::UniformRealDistribution<real>              distA(2.0, 5.0);
 130     gmx::UniformRealDistribution<real>              distB; // default parameters
 131     gmx::UniformRealDistribution<real>::param_type  paramA(2.0, 5.0);
 132     gmx::UniformRealDistribution<real>::result_type valA, valB;
 133
 134     EXPECT_NE(distA(rngA), distB(rngB));
 135     rngA.restart();
 136     rngB.restart();
 137     distA.reset();
 138     distB.reset();
 139
 140     valA = distA(rngA);
 141     valB = distB(rngB, paramA);
 142
 143     // Use floating-point test with no tolerance rather than exact test,
 144     // since the latter fails with 32-bit gcc-4.8.4
 145     EXPECT_REAL_EQ_TOL(valA, valB, gmx::test::ulpTolerance(0));
 146 }
 147
 148 }      // namespace anonymous
 149
 150 }      // namespace gmx