src/gromacs/math/tests/testarrayrefs.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018, 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 /*! \libinternal \file
  36  * \brief Declares functions for comparing views of vector-like data.
  37  *
  38  * \author Mark Abraham <mark.j.abraham@gmail.com>
  39  * \ingroup module_math
  40  * \inlibraryapi
  41  */
  42 #ifndef GMX_MATH_TESTARRAYREFS_H
  43 #define GMX_MATH_TESTARRAYREFS_H
  44
  45 #include <gtest/gtest.h>
  46
  47 #include "gromacs/math/vectypes.h"
  48
  49 namespace gmx
  50 {
  51 namespace test
  52 {
  53
  54 //! Initialization overload for non-BasicVector
  55 template <typename T>
  56 void fillInputContents(ArrayRef<T> inputRef,
  57                        int         scaleFactor)
  58 {
  59     inputRef[0] = 1;
  60     inputRef[1] = 2;
  61     inputRef[2] = 3;
  62     for (auto &element : inputRef)
  63     {
  64         element *= scaleFactor;
  65     }
  66 }
  67
  68 //! Initialization overload for BasicVector
  69 template <typename T>
  70 void fillInputContents(ArrayRef < BasicVector < T>> inputRef,
  71                        int                          scaleFactor)
  72 {
  73     inputRef[0] = {1, 2, 3};
  74     inputRef[1] = {4, 5, 6};
  75     inputRef[2] = {7, 8, 9};
  76     for (auto &element : inputRef)
  77     {
  78         element *= scaleFactor;
  79     }
  80 }
  81
  82 //! Dispatcher function for filling.
  83 template <typename PaddedVectorOfT>
  84 void fillInput(PaddedVectorOfT *input,
  85                int              scaleFactor)
  86 {
  87     // Use a size for the vector in tests that is prime enough to
  88     // expose problems where they exist.
  89     int sizeOfVector = 3;
  90     input->resizeWithPadding(sizeOfVector);
  91     fillInputContents(makeArrayRef(*input), scaleFactor);
  92     EXPECT_LE(sizeOfVector, input->paddedSize());
  93 }
  94
  95 //! Comparison overload for non-BasicVector
  96 template <typename T>
  97 void compareViews(ArrayRef<T> input,
  98                   ArrayRef<T> output)
  99 {
 100     ASSERT_EQ(input.size(), output.size());
 101     for (index i = 0; i != input.size(); ++i)
 102     {
 103         EXPECT_EQ(input[i], output[i]) << "for index " << i;
 104     }
 105 }
 106
 107 //! Comparison overload for BasicVector<T>
 108 template <typename T>
 109 void compareViews(ArrayRef < BasicVector < T>> input,
 110                   ArrayRef < BasicVector < T>> output)
 111 {
 112     ASSERT_EQ(input.size(), output.size());
 113     for (index i = 0; i != input.size(); ++i)
 114     {
 115         EXPECT_EQ(input[i][XX], output[i][XX]) << "for index " << i;
 116         EXPECT_EQ(input[i][YY], output[i][YY]) << "for index " << i;
 117         EXPECT_EQ(input[i][ZZ], output[i][ZZ]) << "for index " << i;
 118     }
 119 }
 120
 121 } // namespace test
 122 } // namespace gmx
 123
 124 #endif