src/gromacs/math/do_fit.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) 2010,2014, 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 #ifndef GMX_MATH_DO_FIT_H
  38 #define GMX_MATH_DO_FIT_H
  39
  40 #include "../legacyheaders/types/simple.h"
  41 #include "../utility/real.h"
  42
  43 #include "vectypes.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 real calc_similar_ind(gmx_bool bRho, int nind, atom_id *index, real mass[],
  50                       rvec x[], rvec xp[]);
  51 /* Returns RMSD or Rho (depending on bRho) over all atoms in index */
  52
  53 real rmsdev_ind(int nind, atom_id index[], real mass[],
  54                 rvec x[], rvec xp[]);
  55 /* Returns the RMS Deviation betweem x and xp over all atoms in index */
  56
  57 real rmsdev(int natoms, real mass[], rvec x[], rvec xp[]);
  58 /* Returns the RMS Deviation betweem x and xp over all atoms */
  59
  60 real rhodev_ind(int nind, atom_id index[], real mass[], rvec x[], rvec xp[]);
  61 /* Returns size-independent Rho similarity parameter over all atoms in index
  62  * Maiorov & Crippen, PROTEINS 22, 273 (1995).
  63  */
  64
  65 real rhodev(int natoms, real mass[], rvec x[], rvec xp[]);
  66 /* Returns size-independent Rho similarity parameter over all atoms
  67  * Maiorov & Crippen, PROTEINS 22, 273 (1995).
  68  */
  69
  70 void calc_fit_R(int ndim, int natoms, real *w_rls, rvec *xp, rvec *x,
  71                 matrix R);
  72 /* Calculates the rotation matrix R for which
  73  * sum_i w_rls_i (xp_i - R x_i).(xp_i - R x_i)
  74  * is minimal. ndim=3 gives full fit, ndim=2 gives xy fit.
  75  * This matrix is also used do_fit.
  76  * x_rotated[i] = sum R[i][j]*x[j]
  77  */
  78
  79 void do_fit_ndim(int ndim, int natoms, real *w_rls, rvec *xp, rvec *x);
  80 /* Do a least squares fit of x to xp. Atoms which have zero mass
  81  * (w_rls[i]) are not taken into account in fitting.
  82  * This makes is possible to fit eg. on Calpha atoms and orient
  83  * all atoms. The routine only fits the rotational part,
  84  * therefore both xp and x should be centered round the origin.
  85  */
  86
  87 void do_fit(int natoms, real *w_rls, rvec *xp, rvec *x);
  88 /* Calls do_fit with ndim=3, thus fitting in 3D */
  89
  90 void reset_x_ndim(int ndim, int ncm, const atom_id *ind_cm,
  91                   int nreset, const atom_id *ind_reset,
  92                   rvec x[], const real mass[]);
  93 /* Put the center of mass of atoms in the origin for dimensions 0 to ndim.
  94  * The center of mass is computed from the index ind_cm.
  95  * When ind_cm!=NULL the COM is determined using ind_cm.
  96  * When ind_cm==NULL the COM is determined for atoms 0 to ncm.
  97  * When ind_reset!=NULL the coordinates indexed by ind_reset are reset.
  98  * When ind_reset==NULL the coordinates up to nreset are reset.
  99  */
 100
 101 void reset_x(int ncm, const atom_id *ind_cm,
 102              int nreset, const atom_id *ind_reset,
 103              rvec x[], const real mass[]);
 104 /* Calls reset_x with ndim=3, thus resetting all dimesions */
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif