src/gromacs/random/tests/tabulatednormaldistribution.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 tabulated normal distribution
  37  *
  38  * \author Erik Lindahl <erik.lindahl@gmail.com>
  39  * \ingroup module_random
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "gromacs/random/tabulatednormaldistribution.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(TabulatedNormalDistributionTest, Output14)
  59 {
  60     gmx::test::TestReferenceData         data;
  61     gmx::test::TestReferenceChecker      checker(data.rootChecker());
  62
  63     gmx::ThreeFry2x64<2>                 rng(123456, gmx::RandomDomain::Other);
  64     gmx::TabulatedNormalDistribution<>   dist(2.0, 5.0); // Use default 14-bit resolution
  65     std::vector<float>                   result;
  66
  67     result.reserve(10);
  68     for (int i = 0; i < 10; i++)
  69     {
  70         result.push_back(dist(rng));
  71     }
  72     checker.checkSequence(result.begin(), result.end(), "TabulatedNormalDistribution14");
  73 }
  74
  75 TEST(TabulatedNormalDistributionTest, Output16)
  76 {
  77     gmx::test::TestReferenceData                  data;
  78     gmx::test::TestReferenceChecker               checker(data.rootChecker());
  79
  80     gmx::ThreeFry2x64<2>                          rng(123456, gmx::RandomDomain::Other);
  81     gmx::TabulatedNormalDistribution<float, 16>   dist(2.0, 5.0); // Use larger 16-bit table
  82     std::vector<float>                            result;
  83
  84     result.reserve(10);
  85     for (int i = 0; i < 10; i++)
  86     {
  87         result.push_back(dist(rng));
  88     }
  89     checker.checkSequence(result.begin(), result.end(), "TabulatedNormalDistribution16");
  90 }
  91
  92 TEST(TabulatedNormalDistributionTest, OutputDouble14)
  93 {
  94     gmx::test::TestReferenceData                  data;
  95     gmx::test::TestReferenceChecker               checker(data.rootChecker());
  96
  97     gmx::ThreeFry2x64<2>                          rng(123456, gmx::RandomDomain::Other);
  98     gmx::TabulatedNormalDistribution<double>      dist(2.0, 5.0);
  99     std::vector<double>                           result;
 100
 101     result.reserve(10);
 102     for (int i = 0; i < 10; i++)
 103     {
 104         result.push_back(dist(rng));
 105     }
 106     checker.checkSequence(result.begin(), result.end(), "TabulatedNormalDistributionDouble14");
 107 }
 108
 109 TEST(TabulatedNormalDistributionTest, Logical)
 110 {
 111     gmx::ThreeFry2x64<2>                 rng(123456, gmx::RandomDomain::Other);
 112     gmx::TabulatedNormalDistribution<>   distA(2.0, 5.0);
 113     gmx::TabulatedNormalDistribution<>   distB(2.0, 5.0);
 114     gmx::TabulatedNormalDistribution<>   distC(3.0, 5.0);
 115     gmx::TabulatedNormalDistribution<>   distD(2.0, 4.0);
 116
 117     EXPECT_EQ(distA, distB);
 118     EXPECT_NE(distA, distC);
 119     EXPECT_NE(distA, distD);
 120 }
 121
 122
 123 TEST(TabulatedNormalDistributionTest, Reset)
 124 {
 125     gmx::ThreeFry2x64<2>                                      rng(123456, gmx::RandomDomain::Other);
 126     gmx::TabulatedNormalDistribution<>                        distA(2.0, 5.0);
 127     gmx::TabulatedNormalDistribution<>                        distB(2.0, 5.0);
 128     gmx::TabulatedNormalDistribution<>::result_type           valA, valB;
 129
 130     valA = distA(rng);
 131
 132     distB(rng);
 133     rng.restart();
 134     distB.reset();
 135
 136     valB = distB(rng);
 137
 138     EXPECT_REAL_EQ_TOL(valA, valB, gmx::test::ulpTolerance(0));
 139 }
 140
 141 TEST(TabulatedNormalDistributionTest, AltParam)
 142 {
 143     gmx::ThreeFry2x64<2>                            rngA(123456, gmx::RandomDomain::Other);
 144     gmx::ThreeFry2x64<2>                            rngB(123456, gmx::RandomDomain::Other);
 145     gmx::TabulatedNormalDistribution<>              distA(2.0, 5.0);
 146     gmx::TabulatedNormalDistribution<>              distB;
 147     gmx::TabulatedNormalDistribution<>::param_type  paramA(2.0, 5.0);
 148
 149     EXPECT_NE(distA(rngA), distB(rngB));
 150     rngA.restart();
 151     rngB.restart();
 152     distA.reset();
 153     distB.reset();
 154     EXPECT_REAL_EQ_TOL(distA(rngA), distB(rngB, paramA), gmx::test::ulpTolerance(0));
 155 }
 156
 157 TEST(TabulatedNormalDistributionTableTest, HasValidProperties)
 158 {
 159     auto table = TabulatedNormalDistribution<real>::makeTable();
 160
 161     EXPECT_EQ(table.size() % 2, 0) << "Table must have even number of entries";
 162
 163     size_t halfSize     = table.size() / 2;
 164     double sumOfSquares = 0.0;
 165     // accept errors of a few ULP since the exact value of the summation
 166     // below will depend on whether the compiler issues FMA instructions
 167     auto   tolerance    = gmx::test::ulpTolerance(10);
 168     for (size_t i = 0, iFromEnd = table.size()-1; i < halfSize; ++i, --iFromEnd)
 169     {
 170         EXPECT_REAL_EQ_TOL(table.at(i), -table.at(iFromEnd), tolerance)
 171         << "Table is not an odd-valued function for entries " << i << " and " << iFromEnd;
 172         // Add up the squares of the table values in order of ascending
 173         // magnitude (to minimize accumulation of round-off error).
 174         sumOfSquares += table.at(i) * table.at(i) + table.at(iFromEnd) * table.at(iFromEnd);
 175     }
 176
 177     double variance = sumOfSquares / table.size();
 178     EXPECT_REAL_EQ_TOL(1.0, variance, tolerance) << "Table should have unit variance";
 179 }
 180
 181 }      // namespace anonymous
 182
 183 }      // namespace gmx