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