include/mtxio.h

   1 /*
   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 3.2.0
  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-2004, 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  * Green Red Orange Magenta Azure Cyan Skyblue
  34  */
  35 #ifdef HAVE_CONFIG_H
  36 #include <config.h>
  37 #endif
  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
  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 void
  61 gmx_mtxio_write(const char *             filename,
  62                 int                      nrow,
  63                 int                      ncol,
  64                 real *                   full_matrix,
  65                 gmx_sparsematrix_t *     sparse_matrix);
  66
  67
  68 /* Read a matrix from file.
  69  *
  70  * This routine will autodetect the matrix format stored in the file
  71  * (sparse or full) and set either the full or sparse matrix arguments (ptr to ptr)
  72  * to a newly allocated matrix structure. Note that the full storage
  73  * structure is simply nrow*ncol floating-point elements. The sparse
  74  * matrix structure should be freed with gmx_sparsematrix_destroy() when you are done.
  75  *
  76  * To determine the format you should set full_matrix and sparse_matrix to NULL
  77  * before calling this routine, and check which one is non-NULL on return.
  78  */
  79 void
  80 gmx_mtxio_read (const char *            filename,
  81                 int *                   nrow,
  82                 int *                   ncol,
  83                 real **                 full_matrix,
  84                 gmx_sparsematrix_t **   sparse_matrix);
  85
  86 #ifdef __cplusplus
  87 }
  88 #endif
  89
  90 #endif
  91