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