src/testutils/testmatchers.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020, 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
  36 /*! \internal \file
  37  * \brief Implements floating-point matchers from testmatchers.h for
  38  * use with Google Mock.
  39  *
  40  * \author Mark Abraham <mark.j.abraham@gmail.com>
  41  * \ingroup module_testutils
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "testutils/testmatchers.h"
  46
  47 #include <memory>
  48
  49 #include <gmock/gmock.h>
  50
  51 #include "gromacs/math/vectypes.h"
  52
  53 #include "testutils/testasserts.h"
  54
  55 namespace gmx
  56 {
  57 namespace test
  58 {
  59
  60 /*! \brief Implementation class for RealEq matcher.
  61  *
  62  * See RealEq().
  63  *
  64  * The implementation is templated so that we can support all of real,
  65  * float and double in the same build without duplication.
  66  */
  67 template<typename FloatType>
  68 class FloatTypeMatcher : public testing::MatcherInterface<std::tuple<FloatType, FloatType>>
  69 {
  70 public:
  71     //! Constructor
  72     FloatTypeMatcher(const FloatingPointTolerance& tolerance) : tolerance_(tolerance) {}
  73     //! Compare the two elements of \c arg, return whether they are equal, and comment on \c listener when they are not.
  74     bool MatchAndExplain(std::tuple<FloatType, FloatType> arg, testing::MatchResultListener* listener) const override
  75     {
  76         const FloatType&        value1 = std::get<0>(arg);
  77         const FloatType&        value2 = std::get<1>(arg);
  78         FloatingPointDifference diff(value1, value2);
  79         if (tolerance_.isWithin(diff))
  80         {
  81             return true;
  82         }
  83         *listener->stream() << "  Actual value: " << value2 << std::endl
  84                             << "Expected value: " << value1 << std::endl
  85                             << "    Difference: " << diff.toString() << std::endl
  86                             << "     Tolerance: " << tolerance_.toString(diff);
  87         return false;
  88     }
  89     //! Describe to a human what matching means.
  90     void DescribeTo(::std::ostream* os) const override { *os << "matches within tolerance"; }
  91     //! Describe to a human what failing to match means.
  92     void DescribeNegationTo(::std::ostream* os) const override
  93     {
  94         *os << "does not match within tolerance";
  95     }
  96
  97 private:
  98     //! Tolerance used in matching
  99     FloatingPointTolerance tolerance_;
 100 };
 101
 102 testing::Matcher<std::tuple<float, float>> FloatEq(const FloatingPointTolerance& tolerance)
 103 {
 104     return testing::MakeMatcher(new FloatTypeMatcher<float>(tolerance));
 105 }
 106
 107 testing::Matcher<std::tuple<double, double>> DoubleEq(const FloatingPointTolerance& tolerance)
 108 {
 109     return testing::MakeMatcher(new FloatTypeMatcher<double>(tolerance));
 110 }
 111
 112 testing::Matcher<std::tuple<real, real>> RealEq(const FloatingPointTolerance& tolerance)
 113 {
 114     return testing::MakeMatcher(new FloatTypeMatcher<real>(tolerance));
 115 }
 116
 117 /*! \brief Implementation class for RvecEq matcher
 118  *
 119  * See RvecEq().
 120  */
 121 template<typename FloatType>
 122 class RVecMatcher :
 123     public testing::MatcherInterface<std::tuple<BasicVector<FloatType>, BasicVector<FloatType>>>
 124 {
 125 public:
 126     //! Convenience type
 127     using VectorType = BasicVector<FloatType>;
 128     //! Constructor
 129     RVecMatcher(const FloatingPointTolerance& tolerance) : tolerance_(tolerance) {}
 130     //! Compare the two elements of \c arg, return whether they are equal, and comment on \c listener when they are not.
 131     bool MatchAndExplain(std::tuple<VectorType, VectorType> arg,
 132                          testing::MatchResultListener*      listener) const override
 133     {
 134         const VectorType&           lhs = std::get<0>(arg);
 135         const VectorType&           rhs = std::get<1>(arg);
 136         FloatTypeMatcher<FloatType> floatTypeMatcher(tolerance_);
 137         bool                        matches = true;
 138         for (int d = 0; d < DIM; ++d)
 139         {
 140             auto floatTuple = std::make_tuple<FloatType, FloatType>(lhs[d], rhs[d]);
 141             matches         = matches && floatTypeMatcher.MatchAndExplain(floatTuple, listener);
 142         }
 143         return matches;
 144     }
 145     //! Describe to a human what matching means.
 146     void DescribeTo(::std::ostream* os) const override
 147     {
 148         *os << "matches all elements within tolerance";
 149     }
 150     //! Describe to a human what failing to match means.
 151     void DescribeNegationTo(::std::ostream* os) const override
 152     {
 153         *os << "does not match all elements within tolerance";
 154     }
 155
 156 private:
 157     //! Tolerance used in matching
 158     FloatingPointTolerance tolerance_;
 159 };
 160
 161 // Currently there's no need for explicit float or double flavours of
 162 // RVec comparison, but those would be simple to add later.
 163 testing::Matcher<std::tuple<RVec, RVec>> RVecEq(const FloatingPointTolerance& tolerance)
 164 {
 165     return testing::MakeMatcher(new RVecMatcher<real>(tolerance));
 166 }
 167
 168 } // namespace test
 169 } // namespace gmx