include/mtxio.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, 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 /* This module provides routines to read/write sparse or full storage
  40  * matrices from/to files. It is normally used for the Hessian matrix
  41  * in normal mode analysis.
  42  */
  43
  44 #ifndef _MTXIO_H_
  45 #define _MTXIO_H_
  46 #include "visibility.h"
  47 #include "types/simple.h"
  48 #include "sparsematrix.h"
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 /* Write a full or sparse matrix to a file.
  55  *
  56  * You should provide the filename, dimensions (nrow/ncol), and
  57  * EITHER a pointer to a full storage matrix or a sparse storage
  58  * matrix. If both pointers are non-NULL a fatal error will occur.
  59  */
  60 GMX_LIBGMX_EXPORT
  61 void
  62 gmx_mtxio_write(const char *             filename,
  63                 int                      nrow,
  64                 int                      ncol,
  65                 real *                   full_matrix,
  66                 gmx_sparsematrix_t *     sparse_matrix);
  67
  68
  69 /* Read a matrix from file.
  70  *
  71  * This routine will autodetect the matrix format stored in the file
  72  * (sparse or full) and set either the full or sparse matrix arguments (ptr to ptr)
  73  * to a newly allocated matrix structure. Note that the full storage
  74  * structure is simply nrow*ncol floating-point elements. The sparse
  75  * matrix structure should be freed with gmx_sparsematrix_destroy() when you are done.
  76  *
  77  * To determine the format you should set *full_matrix and *sparse_matrix to NULL
  78  * before calling this routine, and check which one is non-NULL on return.
  79  */
  80 GMX_LIBGMX_EXPORT
  81 void
  82 gmx_mtxio_read (const char *            filename,
  83                 int *                   nrow,
  84                 int *                   ncol,
  85                 real **                 full_matrix,
  86                 gmx_sparsematrix_t **   sparse_matrix);
  87
  88 #ifdef __cplusplus
  89 }
  90 #endif
  91
  92 #endif
  93