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