src/gromacs/random/tests/random.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014, 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
  37  * Tests utilities for random number generation.
  38  *
  39  * \author Roland Schulz <roland@utk.edu>
  40  * \ingroup module_random
  41  */
  42 #include "gmxpre.h"
  43
  44 #include <vector>
  45
  46 #include <gtest/gtest.h>
  47
  48 #include "external/Random123-1.08/include/Random123/threefry.h"
  49
  50 #include "testutils/refdata.h"
  51
  52 namespace
  53 {
  54
  55 class Threefry : public ::testing::TestWithParam<std::pair<threefry2x64_ctr_t,
  56                                                            threefry2x64_key_t> >
  57 {
  58 };
  59
  60 TEST_P(Threefry, 2x64)
  61 {
  62     gmx::test::TestReferenceData    data;
  63
  64     gmx::test::TestReferenceChecker checker(data.rootChecker());
  65
  66     const std::pair<threefry2x64_ctr_t, threefry2x64_key_t> input = GetParam();
  67
  68     threefry2x64_ctr_t rand = threefry2x64(input.first, input.second);
  69
  70     checker.checkSequenceArray(2, rand.v, "Threefry2x64");
  71 }
  72
  73 //The input values are the same as the ones used by Known Answer Tests (kat) in
  74 //Random123. Reference values agree with those in kat_vectors
  75 /** input value: zero */
  76 const threefry2x64_ctr_t tf_zero = {{0, 0}};
  77 /** input value: max unit64 */
  78 const threefry2x64_ctr_t tf_max  = {{std::numeric_limits<gmx_uint64_t>::max(),
  79                                      std::numeric_limits<gmx_uint64_t>::max()}};
  80 /** input value: Pi */
  81 const threefry2x64_ctr_t tf_pi1  = {{0x243f6a8885a308d3, 0x13198a2e03707344}};
  82 /** input value: More Pi */
  83 const threefry2x64_ctr_t tf_pi2  = {{0xa4093822299f31d0, 0x082efa98ec4e6c89}};
  84
  85 INSTANTIATE_TEST_CASE_P(0_ff_pi, Threefry,
  86                             ::testing::Values(std::make_pair(tf_zero, tf_zero),
  87                                               std::make_pair(tf_max, tf_max),
  88                                               std::make_pair(tf_pi1, tf_pi2)));
  89
  90 } // namespace