Added documentation about proper use of pdb2gmx -ter.
[gromacs/rigid-bodies.git] / include / gmx_matrix.h
blob37f38b8c2e0080ef39f7db5a86192273558524b2
1 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
2 *
3 * This source code is part of
4 *
5 * G R O M A C S
6 *
7 * GROningen MAchine for Chemical Simulations
8 *
9 * VERSION 4.0.99
10 * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
11 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
12 * Copyright (c) 2001-2008, The GROMACS development team,
13 * check out http://www.gromacs.org for more information.
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version 2
18 * of the License, or (at your option) any later version.
20 * If you want to redistribute modifications, please consider that
21 * scientific software is very special. Version control is crucial -
22 * bugs must be traceable. We will be happy to consider code for
23 * inclusion in the official distribution, but derived work must not
24 * be called official GROMACS. Details are found in the README & COPYING
25 * files - if they are missing, get the official version at www.gromacs.org.
27 * To help us fund GROMACS development, we humbly ask that you cite
28 * the papers on the package - you can find them in the top README file.
30 * For more info, check our website at http://www.gromacs.org
32 * And Hey:
33 * Groningen Machine for Chemical Simulation
36 #ifndef _gmx_matrix_h
37 #define _gmx_matrix_h
39 #include <stdio.h>
41 double **alloc_matrix(int n,int m);
43 void free_matrix(double **a,int n);
45 void matrix_multiply(FILE *fp,int n,int m,double **x,double **y,double **z);
47 /* Return 0 if OK or row number where inversion failed otherwise. */
48 int matrix_invert(FILE *fp,int n,double **a);
50 double multi_regression(FILE *fp,int ny,double *y,
51 int nx,double **xx,double *a0);
52 /* Perform a regression analysis to fit
53 * y' = a0[0] xx[0] + a0[1] xx[1] ... + a0[nx-1] xx[nx-1]
54 * with ny data points in each vector.
55 * The coefficients are returned in vector a0.
56 * The return value of the function is the chi2 value:
57 * sum_{j=0}^{ny-1} (y[j] - y'[j])^2
58 * If fp is not NULL debug information will be written to it.
61 #endif