src/testutils/tests/testasserts_tests.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 /*! \internal \file
  36  * \brief
  37  * Tests \Gromacs-specific test assertions.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "testutils/testasserts.h"
  43
  44 #include <gtest/gtest.h>
  45
  46 namespace
  47 {
  48
  49 using ::testing::internal::FloatingPoint;
  50
  51 /*! \brief
  52  * Helper to produce floating-point numbers with specified ULP difference.
  53  *
  54  * This doesn't work if the value would change sign.
  55  *
  56  * \ingroup module_testutils
  57  */
  58 template <typename FloatType>
  59 FloatType addUlps(FloatType value, int ulps)
  60 {
  61     return FloatingPoint<FloatType>::ReinterpretBits(
  62             FloatingPoint<FloatType>(value).bits() + ulps);
  63 }
  64
  65 using ::gmx::test::FloatingPointDifference;
  66
  67 TEST(FloatingPointDifferenceTest, HandlesEqualValues)
  68 {
  69     FloatingPointDifference diff(1.2, 1.2);
  70     EXPECT_FALSE(diff.isNaN());
  71     EXPECT_EQ(0.0, diff.asAbsolute());
  72     EXPECT_EQ(0U,  diff.asUlps());
  73     EXPECT_FALSE(diff.signsDiffer());
  74 }
  75
  76 TEST(FloatingPointDifferenceTest, HandlesZerosOfDifferentSign)
  77 {
  78     FloatingPointDifference diff(0.0, -0.0);
  79     EXPECT_FALSE(diff.isNaN());
  80     EXPECT_EQ(0.0, diff.asAbsolute());
  81     EXPECT_EQ(0U,  diff.asUlps());
  82     EXPECT_TRUE(diff.signsDiffer());
  83 }
  84
  85 TEST(FloatingPointDifferenceTest, HandlesSignComparisonWithZero)
  86 {
  87     {
  88         FloatingPointDifference diff(0.0, -1.2);
  89         EXPECT_FALSE(diff.isNaN());
  90         EXPECT_DOUBLE_EQ(1.2, diff.asAbsolute());
  91         EXPECT_TRUE(diff.signsDiffer());
  92     }
  93     {
  94         FloatingPointDifference diff(-0.0, -1.2);
  95         EXPECT_FALSE(diff.isNaN());
  96         EXPECT_DOUBLE_EQ(1.2, diff.asAbsolute());
  97         EXPECT_FALSE(diff.signsDiffer());
  98     }
  99 }
 100
 101 TEST(FloatingPointDifferenceTest, HandlesUlpDifferences)
 102 {
 103     const double first  = 1.0;
 104     const double second = addUlps(first, 2);
 105     {
 106         FloatingPointDifference diff(first, second);
 107         EXPECT_FALSE(diff.isNaN());
 108         EXPECT_DOUBLE_EQ(second - first, diff.asAbsolute());
 109         EXPECT_EQ(2U, diff.asUlps());
 110         EXPECT_FALSE(diff.signsDiffer());
 111     }
 112     {
 113         FloatingPointDifference diff(second, first);
 114         EXPECT_FALSE(diff.isNaN());
 115         EXPECT_DOUBLE_EQ(second - first, diff.asAbsolute());
 116         EXPECT_EQ(2U, diff.asUlps());
 117         EXPECT_FALSE(diff.signsDiffer());
 118     }
 119 }
 120
 121 TEST(FloatingPointDifferenceTest, HandlesUlpDifferenceAcrossZero)
 122 {
 123     const double            first  = addUlps(-0.0, 2);
 124     const double            second = addUlps( 0.0, 2);
 125     FloatingPointDifference diff(first, second);
 126     EXPECT_FALSE(diff.isNaN());
 127     EXPECT_DOUBLE_EQ(second - first, diff.asAbsolute());
 128     EXPECT_EQ(4U, diff.asUlps());
 129     EXPECT_TRUE(diff.signsDiffer());
 130 }
 131
 132 TEST(FloatingPointDifferenceTest, HandlesNaN)
 133 {
 134     const double            first  = std::numeric_limits<double>::quiet_NaN();
 135     const double            second = 2.0;
 136     FloatingPointDifference diff(first, second);
 137     EXPECT_TRUE(diff.isNaN());
 138 }
 139
 140 } // namespace