Code beautification with uncrustify
[alexxy/gromacs.git] / src / gromacs / linearalgebra / matrix.h
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.
14
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.
19  *
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.
26  *
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.
29  *
30  * For more info, check our website at http://www.gromacs.org
31  *
32  * And Hey:
33  * Groningen Machine for Chemical Simulation
34  */
35 #ifndef GMX_LINEARALGEBRA_MATRIX_H
36 #define GMX_LINEARALGEBRA_MATRIX_H
37
38 #include <stdio.h>
39
40 #ifdef __cplusplus
41 extern "C"
42 {
43 #endif
44
45 double **alloc_matrix(int n, int m);
46
47 void free_matrix(double **a, int n);
48
49 void matrix_multiply(FILE *fp, int n, int m, double **x, double **y, double **z);
50
51 /* Return 0 if OK or row number where inversion failed otherwise. */
52 int matrix_invert(FILE *fp, int n, double **a);
53
54 double multi_regression(FILE *fp, int ny, double *y,
55                         int nx, double **xx, double *a0);
56 /* Perform a regression analysis to fit
57  * y' = a0[0] xx[0] + a0[1] xx[1] ... + a0[nx-1] xx[nx-1]
58  * with ny data points in each vector.
59  * The coefficients are returned in vector a0.
60  * The return value of the function is the chi2 value:
61  * sum_{j=0}^{ny-1} (y[j] - y'[j])^2
62  * If fp is not NULL debug information will be written to it.
63  */
64
65 #ifdef __cplusplus
66 }
67 #endif
68
69 #endif