include/gmx_matrix.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-2008, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, 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 _gmx_matrix_h
  40 #define _gmx_matrix_h
  41
  42 #include <stdio.h>
  43 #include "visibility.h"
  44
  45 double **alloc_matrix(int n,int m);
  46
  47 GMX_LIBGMX_EXPORT
  48 void free_matrix(double **a,int n);
  49
  50 void matrix_multiply(FILE *fp,int n,int m,double **x,double **y,double **z);
  51
  52 /* Return 0 if OK or row number where inversion failed otherwise. */
  53 int matrix_invert(FILE *fp,int n,double **a);
  54
  55 GMX_LIBGMX_EXPORT
  56 double multi_regression(FILE *fp,int ny,double *y,
  57                                int nx,double **xx,double *a0);
  58 /* Perform a regression analysis to fit
  59  * y' = a0[0] xx[0] + a0[1] xx[1] ... + a0[nx-1] xx[nx-1]
  60  * with ny data points in each vector.
  61  * The coefficients are returned in vector a0.
  62  * The return value of the function is the chi2 value:
  63  * sum_{j=0}^{ny-1} (y[j] - y'[j])^2
  64  * If fp is not NULL debug information will be written to it.
  65  */
  66
  67 #endif