Fixing copyright issues and code contributors
[alexxy/gromacs.git] / src / tools / cmat.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  * check out http://www.gromacs.org for more information.
7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
9  * others, as listed in the AUTHORS file in the top-level source
10  * 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
39 #ifndef _cmat_h
40 #define _cmat_h
41
42 #include "typedefs.h"
43
44 typedef struct {
45   int  i,j;
46   real dist;
47 } t_dist;
48
49 typedef struct {
50   int  conf,clust;
51 } t_clustid;
52
53 typedef struct {
54   int  n1,nn;
55   int  *m_ind;
56   gmx_bool b1D;
57   real emat,minrms,maxrms,sumrms;
58   real *erow;
59   real **mat;
60 } t_mat;
61
62 /* The matrix is indexed using the matrix index */
63 #define EROW(m,i)  m->erow[i]
64
65 extern t_mat *init_mat(int n1,gmx_bool b1D);
66
67 extern void enlarge_mat(t_mat *m,int deltan);
68
69 extern void reset_index(t_mat *m);
70
71 extern void swap_rows(t_mat *m,int isw,int jsw);
72
73 extern void set_mat_entry(t_mat *m,int i,int j,real val);
74
75 extern void done_mat(t_mat **m);
76
77 extern real row_energy(int n1,int row,real *mat);
78
79 extern real mat_energy(t_mat *mat);
80
81 extern void swap_mat(t_mat *m);
82
83 extern void low_rmsd_dist(const char *fn,real maxrms,int nn,real **mat,
84                           const output_env_t oenv);
85
86 extern void rmsd_distribution(const char *fn,t_mat *m,const output_env_t oenv);
87
88 extern t_clustid *new_clustid(int n1);
89
90 #endif