src/gromacs/math/veccompare.cpp

   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,2019,2020, 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 #include "gmxpre.h"
  38
  39 #include "veccompare.h"
  40
  41 #include <cmath>
  42 #include <cstdio>
  43
  44 #include "gromacs/utility/compare.h"
  45
  46 void cmp_rvec(FILE* fp, const char* s, int index, const rvec i1, const rvec i2, real ftol, real abstol)
  47 {
  48     if (!equal_real(i1[XX], i2[XX], ftol, abstol) || !equal_real(i1[YY], i2[YY], ftol, abstol)
  49         || !equal_real(i1[ZZ], i2[ZZ], ftol, abstol))
  50     {
  51         if (index != -1)
  52         {
  53             fprintf(fp,
  54                     "%s[%5d] (%12.5e %12.5e %12.5e) - (%12.5e %12.5e %12.5e)\n",
  55                     s,
  56                     index,
  57                     i1[XX],
  58                     i1[YY],
  59                     i1[ZZ],
  60                     i2[XX],
  61                     i2[YY],
  62                     i2[ZZ]);
  63         }
  64         else
  65         {
  66             fprintf(fp,
  67                     "%s (%12.5e %12.5e %12.5e) - (%12.5e %12.5e %12.5e)\n",
  68                     s,
  69                     i1[XX],
  70                     i1[YY],
  71                     i1[ZZ],
  72                     i2[XX],
  73                     i2[YY],
  74                     i2[ZZ]);
  75         }
  76     }
  77 }
  78
  79 void cmp_ivec(FILE* fp, const char* s, int index, const ivec i1, const ivec i2)
  80 {
  81     if ((i1[XX] != i2[XX]) || (i1[YY] != i2[YY]) || (i1[ZZ] != i2[ZZ]))
  82     {
  83         if (index != -1)
  84         {
  85             fprintf(fp,
  86                     "%s[%5d] (%8d,%8d,%8d - %8d,%8d,%8d)\n",
  87                     s,
  88                     index,
  89                     i1[XX],
  90                     i1[YY],
  91                     i1[ZZ],
  92                     i2[XX],
  93                     i2[YY],
  94                     i2[ZZ]);
  95         }
  96         else
  97         {
  98             fprintf(fp, "%s (%8d,%8d,%8d - %8d,%8d,%8d)\n", s, i1[XX], i1[YY], i1[ZZ], i2[XX], i2[YY], i2[ZZ]);
  99         }
 100     }
 101 }
 102
 103 static void cmp_rvecs_rmstol(FILE* fp, const char* title, int n, const rvec x1[], const rvec x2[], real ftol, real abstol)
 104 {
 105     int    i, m;
 106     double rms;
 107
 108     /* For a vector you are usally not interested in a relative difference
 109      * on a component that is very small compared to the other components.
 110      * Therefore we do the relative comparision relative to the RMS component.
 111      */
 112     rms = 0.0;
 113     for (i = 0; (i < n); i++)
 114     {
 115         for (m = 0; m < DIM; m++)
 116         {
 117             rms += x1[i][m] * x1[i][m] + x2[i][m] * x2[i][m];
 118         }
 119     }
 120     rms = sqrt(rms / (2 * n * DIM));
 121
 122     /* Convert the relative tolerance into an absolute tolerance */
 123     if (ftol * rms < abstol)
 124     {
 125         abstol = ftol * rms;
 126     }
 127
 128     /* And now do the actual comparision */
 129     for (i = 0; (i < n); i++)
 130     {
 131         cmp_rvec(fp, title, i, x1[i], x2[i], 0.0, abstol);
 132     }
 133 }
 134
 135 void cmp_rvecs(FILE* fp, const char* title, int n, const rvec x1[], const rvec x2[], gmx_bool bRMSD, real ftol, real abstol)
 136 {
 137     int    i, m;
 138     double d, ssd;
 139
 140     if (bRMSD)
 141     {
 142         ssd = 0;
 143         for (i = 0; (i < n); i++)
 144         {
 145             for (m = 0; m < DIM; m++)
 146             {
 147                 d = x1[i][m] - x2[i][m];
 148                 ssd += d * d;
 149             }
 150         }
 151         fprintf(fp, "%s RMSD %g\n", title, std::sqrt(ssd / n));
 152     }
 153     else
 154     {
 155         cmp_rvecs_rmstol(fp, title, n, x1, x2, ftol, abstol);
 156     }
 157 }