Tagged files with gromacs 3.0 header and added some license info
[alexxy/gromacs.git] / include / do_fit.h
1 /*
2  * $Id$
3  * 
4  *                This source code is part of
5  * 
6  *                 G   R   O   M   A   C   S
7  * 
8  *          GROningen MAchine for Chemical Simulations
9  * 
10  *                        VERSION 3.0
11  * 
12  * Copyright (c) 1991-2001
13  * BIOSON Research Institute, Dept. of Biophysical Chemistry
14  * University of Groningen, The Netherlands
15  * 
16  * This program is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU General Public License
18  * as published by the Free Software Foundation; either version 2
19  * of the License, or (at your option) any later version.
20  * 
21  * If you want to redistribute modifications, please consider that
22  * scientific software is very special. Version control is crucial -
23  * bugs must be traceable. We will be happy to consider code for
24  * inclusion in the official distribution, but derived work must not
25  * be called official GROMACS. Details are found in the README & COPYING
26  * files - if they are missing, get the official version at www.gromacs.org.
27  * 
28  * To help us fund GROMACS development, we humbly ask that you cite
29  * the papers on the package - you can find them in the top README file.
30  * 
31  * Do check out http://www.gromacs.org , or mail us at gromacs@gromacs.org .
32  * 
33  * And Hey:
34  * Good ROcking Metal Altar for Chronical Sinners
35  */
36
37 #ifndef _do_fit_h
38 #define _do_fit_h
39
40 static char *SRCID_do_fit_h = "$Id$";
41 #ifdef HAVE_CONFIG_H
42 #include <config.h>
43 #endif
44
45 #ifdef HAVE_IDENT
46 #ident  "@(#) do_fit.h 1.8 2/2/97"
47 #endif /* HAVE_IDENT */
48 extern real calc_similar_ind(bool bRho,int nind,atom_id *index,real mass[],
49                              rvec x[],rvec xp[]);
50 /* Returns RMSD or Rho (depending on bRho) over all atoms in index */
51
52 extern real rmsdev_ind(int nind,atom_id index[],real mass[],
53                        rvec x[],rvec xp[]);
54 /* Returns the RMS Deviation betweem x and xp over all atoms in index */
55
56 extern real rmsdev(int natoms,real mass[],rvec x[],rvec xp[]);
57 /* Returns the RMS Deviation betweem x and xp over all atoms */
58
59 extern real rhodev_ind(int nind,atom_id index[],real mass[],rvec x[],rvec xp[]);
60 /* Returns size-independent Rho similarity parameter over all atoms in index
61  * Maiorov & Crippen, PROTEINS 22, 273 (1995).
62  */
63  
64 extern real rhodev(int natoms,real mass[],rvec x[],rvec xp[]);
65 /* Returns size-independent Rho similarity parameter over all atoms
66  * Maiorov & Crippen, PROTEINS 22, 273 (1995).
67  */
68
69 extern void do_fit(int natoms,real *w_rls,rvec *xp,rvec *x);
70 /* Do a least squares fit of x to xp. Atoms which have zero mass
71  * (w_rls[i]) are not take into account in fitting.
72  * This makes is possible to fit eg. on Calpha atoms and orient
73  * all atoms. The routine only fits the rotational part,
74  * therefore both xp and x should be centered round the origin.
75  */
76
77 extern void reset_x(int ncm,atom_id ind_cm[],
78                     int nreset,atom_id *ind_reset,rvec x[],real mass[]);
79 /* Put the center of mass of atoms in the origin.
80  * The center of mass is computed from the index ind_cm.
81  * When ind_reset!=NULL the coordinates indexed by ind_reset are reset.
82  * When ind_reset==NULL the coordinates up to nreset are reset.
83  */
84
85 #endif  /* _do_fit_h */