api/nblib/tests/testhelpers.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020,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 /*! \libinternal \file
  36  * \brief
  37  * This implements basic nblib test systems
  38  *
  39  * \author Victor Holanda <victor.holanda@cscs.ch>
  40  * \author Joe Jordan <ejjordan@kth.se>
  41  * \author Prashanth Kanduri <kanduri@cscs.ch>
  42  * \author Sebastian Keller <keller@cscs.ch>
  43  */
  44 #ifndef NBLIB_TESTHELPERS_H
  45 #define NBLIB_TESTHELPERS_H
  46
  47 #include "gromacs/math/vectypes.h"
  48 #include "gromacs/utility/arrayref.h"
  49 #include "nblib/box.h"
  50 #include "nblib/vector.h"
  51
  52 #include "testutils/refdata.h"
  53 #include "testutils/testasserts.h"
  54
  55 namespace nblib
  56 {
  57
  58 namespace test
  59 {
  60
  61 //! Compare between two instances of the Box object
  62 bool operator==(const Box& a, const Box& b);
  63
  64 /*! \internal \brief
  65  *  Simple test harness for checking 3D vectors like coordinates, velocities,
  66  *  forces against reference data
  67  *
  68  */
  69 class Vector3DTest
  70 {
  71 public:
  72     Vector3DTest() : checker_(refData_.rootChecker())
  73     {
  74         gmx::test::FloatingPointTolerance tolerance(
  75                 gmx::test::FloatingPointTolerance(1e-8, 1.0e-12, 1e-8, 1.0e-12, 200, 100, true));
  76         checker_.setDefaultTolerance(tolerance);
  77     }
  78
  79     Vector3DTest(real relativeFloatingPointTolerance) : checker_(refData_.rootChecker())
  80     {
  81         gmx::test::FloatingPointTolerance tolerance(gmx::test::FloatingPointTolerance(
  82                 1e-8, 1.0e-12, relativeFloatingPointTolerance, 1.0e-12, 200, 100, true));
  83         checker_.setDefaultTolerance(tolerance);
  84     }
  85
  86     //! Compare a given input vector of cartesians with the reference data
  87     void testVectors(gmx::ArrayRef<Vec3> forces, const std::string& testName)
  88     {
  89         checker_.checkSequence(forces.begin(), forces.end(), testName.c_str());
  90     }
  91
  92     void testReal(real value, const std::string& testName)
  93     {
  94         checker_.checkReal(value, testName.c_str());
  95     }
  96
  97 private:
  98     gmx::test::TestReferenceData    refData_;
  99     gmx::test::TestReferenceChecker checker_;
 100 };
 101
 102 //! Macros to compare floats and doubles with a specified tolerance
 103 /// \cond DO_NOT_DOCUMENT
 104 #if GMX_DOUBLE
 105 #    define EXPECT_FLOAT_DOUBLE_EQ_TOL(value, refFloat, refDouble, tolerance) \
 106         EXPECT_DOUBLE_EQ_TOL(value, refDouble, tolerance)
 107 #    define ASSERT_FLOAT_DOUBLE_EQ_TOL(value, refFloat, refDouble, tolerance) \
 108         ASSERT_DOUBLE_EQ_TOL(value, refDouble, tolerance)
 109 #else
 110 #    define EXPECT_FLOAT_DOUBLE_EQ_TOL(value, refFloat, refDouble, tolerance) \
 111         EXPECT_FLOAT_EQ_TOL(value, refFloat, tolerance)
 112 #    define ASSERT_FLOAT_DOUBLE_EQ_TOL(value, refFloat, refDouble, tolerance) \
 113         ASSERT_FLOAT_EQ_TOL(value, refFloat, tolerance)
 114 #endif
 115 /// \endcond
 116
 117 } // namespace test
 118 } // namespace nblib
 119 #endif // NBLIB_TESTHELPERS_H