src/gromacs/simd/tests/base.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2018,2019,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 #include "gmxpre.h"
  36
  37 #include "base.h"
  38
  39 #include <cmath>
  40 #include <cstdint>
  41
  42 #include "gromacs/options/basicoptions.h"
  43 #include "gromacs/options/ioptionscontainer.h"
  44 #include "gromacs/utility/basedefinitions.h"
  45
  46 #include "testutils/testoptions.h"
  47
  48 namespace gmx
  49 {
  50 namespace test
  51 {
  52
  53 namespace
  54 {
  55
  56 /*! \cond */
  57 /*! \brief Command-line option to adjust the number of points used to test SIMD math functions. */
  58 GMX_TEST_OPTIONS(SimdBaseTestOptions, options)
  59 {
  60     options->addOption(::gmx::IntegerOption("npoints")
  61                                .store(&SimdBaseTest::s_nPoints)
  62                                .description("Number of points to test for SIMD math functions"));
  63 }
  64 /*! \endcond */
  65
  66 } // namespace
  67
  68 /*! \cond internal */
  69 /*! \addtogroup module_simd */
  70 /*! \{ */
  71
  72 int SimdBaseTest::s_nPoints = 10000;
  73
  74 ::testing::AssertionResult SimdBaseTest::compareVectorRealUlp(const char*              refExpr,
  75                                                               const char*              tstExpr,
  76                                                               const std::vector<real>& ref,
  77                                                               const std::vector<real>& tst) const
  78 {
  79     std::vector<real>         absDiff(tst.size());
  80     std::vector<std::int64_t> ulpDiff(tst.size());
  81     bool                      allOk;
  82     size_t                    i;
  83
  84     union
  85     {
  86 #if GMX_DOUBLE
  87         double       r;
  88         std::int64_t i;
  89 #else
  90         float        r;
  91         std::int32_t i;
  92 #endif
  93     } conv0, conv1;
  94
  95     // Internal test of the test - make sure reference and test have the same length.
  96     if (ref.size() != tst.size())
  97     {
  98         return ::testing::AssertionFailure()
  99                << "Internal test error - unequal size vectors in compareVectorRealUlp" << std::endl;
 100     }
 101
 102     for (i = 0, allOk = true; i < tst.size(); i++)
 103     {
 104         absDiff[i] = std::abs(ref[i] - tst[i]);
 105         conv0.r    = ref[i];
 106         conv1.r    = tst[i];
 107         ulpDiff[i] = llabs(conv0.i - conv1.i);
 108
 109         /* Use strict smaller-than for absolute tolerance check, so we disable it with absTol_=0 */
 110         allOk = allOk && ((absDiff[i] < absTol_) || ((ref[i] * tst[i] >= 0) && (ulpDiff[i] <= ulpTol_)));
 111     }
 112
 113     if (allOk)
 114     {
 115         return ::testing::AssertionSuccess();
 116     }
 117     else
 118     {
 119         return ::testing::AssertionFailure()
 120                << "Failing comparison between " << refExpr << " and " << tstExpr << std::endl
 121                << "Requested abs tolerance: " << absTol_ << std::endl
 122                << "Requested ulp tolerance: " << ulpTol_ << std::endl
 123                << "(And values should not differ in sign unless within abs tolerance.)" << std::endl
 124                << "Reference values: " << ::testing::PrintToString(ref) << std::endl
 125                << "SIMD values:      " << ::testing::PrintToString(tst) << std::endl
 126                << "Abs. difference:  " << ::testing::PrintToString(absDiff) << std::endl
 127                << "Ulp difference:   " << ::testing::PrintToString(ulpDiff) << std::endl;
 128     }
 129 }
 130
 131 /*! \} */
 132 /*! \endcond */
 133
 134 } // namespace test
 135 } // namespace gmx