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, 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
  75 SimdBaseTest::compareVectorRealUlp(const char * refExpr,   const char * tstExpr,
  76                                    const std::vector<real> &ref, const std::vector<real> &tst)
  77 {
  78     std::vector<real>             absDiff(tst.size());
  79     std::vector<std::int64_t>     ulpDiff(tst.size());
  80     bool                          allOk;
  81     size_t                        i;
  82
  83     union {
  84 #if GMX_DOUBLE
  85         double r; std::int64_t i;
  86 #else
  87         float  r; std::int32_t i;
  88 #endif
  89     } conv0, conv1;
  90
  91     // Internal test of the test - make sure reference and test have the same length.
  92     if (ref.size() != tst.size())
  93     {
  94         return ::testing::AssertionFailure()
  95                << "Internal test error - unequal size vectors in compareVectorRealUlp" << std::endl;
  96     }
  97
  98     for (i = 0, allOk = true; i < tst.size(); i++)
  99     {
 100         absDiff[i]  = std::abs(ref[i]-tst[i]);
 101         conv0.r     = ref[i];
 102         conv1.r     = tst[i];
 103         ulpDiff[i]  = llabs(conv0.i-conv1.i);
 104
 105         /* Use strict smaller-than for absolute tolerance check, so we disable it with absTol_=0 */
 106         allOk       = allOk && ( ( absDiff[i] < absTol_ ) || ( ( ref[i]*tst[i] >= 0 ) && (ulpDiff[i] <= ulpTol_) ) );
 107     }
 108
 109     if (allOk)
 110     {
 111         return ::testing::AssertionSuccess();
 112     }
 113     else
 114     {
 115         return ::testing::AssertionFailure()
 116                << "Failing comparison between " << refExpr << " and " << tstExpr << std::endl
 117                << "Requested abs tolerance: " << absTol_ << std::endl
 118                << "Requested ulp tolerance: " << ulpTol_ << std::endl
 119                << "(And values should not differ in sign unless within abs tolerance.)" << std::endl
 120                << "Reference values: " << ::testing::PrintToString(ref) << std::endl
 121                << "SIMD values:      " << ::testing::PrintToString(tst) << std::endl
 122                << "Abs. difference:  " << ::testing::PrintToString(absDiff) << std::endl
 123                << "Ulp difference:   " << ::testing::PrintToString(ulpDiff) << std::endl;
 124     }
 125 }
 126
 127 /*! \} */
 128 /*! \endcond */
 129
 130 }      // namespace
 131 }      // namespace