src/gromacs/utility/compare.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \libinternal \file
  39  * \brief
  40  * Utilities for comparing data structures (for gmx check).
  41  *
  42  * \inlibraryapi
  43  * \ingroup module_utility
  44  */
  45 #ifndef GMX_UTILITY_COMPARE_H
  46 #define GMX_UTILITY_COMPARE_H
  47
  48 #include <cstdio>
  49
  50 #include "gromacs/mdtypes/md_enums.h"
  51 #include "gromacs/utility/basedefinitions.h"
  52 #include "gromacs/utility/real.h"
  53
  54 //! Compares two real values for equality.
  55 gmx_bool equal_real(real i1, real i2, real ftol, real abstol);
  56 //! Compares two float values for equality.
  57 gmx_bool equal_float(float i1, float i2, float ftol, float abstol);
  58 //! Compares two double values for equality.
  59 gmx_bool equal_double(double i1, double i2, real ftol, real abstol);
  60
  61 //! Compares two integers and prints differences.
  62 void cmp_int(FILE* fp, const char* s, int index, int i1, int i2);
  63
  64 //! Compares two 64-bit integers and prints differences.
  65 void cmp_int64(FILE* fp, const char* s, int64_t i1, int64_t i2);
  66
  67 //! Compares two unsigned short values and prints differences.
  68 void cmp_us(FILE* fp, const char* s, int index, unsigned short i1, unsigned short i2);
  69
  70 //! Compares two unsigned char values and prints differences.
  71 void cmp_uc(FILE* fp, const char* s, int index, unsigned char i1, unsigned char i2);
  72
  73 //! Compares two boolean values and prints differences, and returns whether both are true.
  74 gmx_bool cmp_bool(FILE* fp, const char* s, int index, gmx_bool b1, gmx_bool b2);
  75
  76 //! Compares two strings and prints differences.
  77 void cmp_str(FILE* fp, const char* s, int index, const char* s1, const char* s2);
  78
  79 //! Compares two reals and prints differences.
  80 void cmp_real(FILE* fp, const char* s, int index, real i1, real i2, real ftol, real abstol);
  81
  82 //! Compares two floats and prints differences.
  83 void cmp_float(FILE* fp, const char* s, int index, float i1, float i2, float ftol, float abstol);
  84
  85 //! Compares two doubles and prints differences.
  86 void cmp_double(FILE* fp, const char* s, int index, double i1, double i2, double ftol, double abstol);
  87
  88 //! Compare two enums of generic type and print differences.
  89 template<typename EnumType>
  90 void cmpEnum(FILE* fp, const char* s, EnumType value1, EnumType value2)
  91 {
  92     if (value1 != value2)
  93     {
  94         fprintf(fp, "%s (", s);
  95         fprintf(fp, "%s", enumValueToString(value1));
  96         fprintf(fp, " - ");
  97         fprintf(fp, "%s", enumValueToString(value2));
  98         fprintf(fp, ")\n");
  99     }
 100 }
 101
 102 #endif