src/testutils/testmatchers.cpp

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