include/sparsematrix.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 #ifndef _SPARSEMATRIX_H_
  36 #define _SPARSEMATRIX_H_
  37 #include "visibility.h"
  38 #include "typedefs.h"
  39 #include "types/simple.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /*! \brief Sparse matrix storage format
  46  *
  47  *  This structure specifies a storage format for a sparse matrix.
  48  *  The memory requirements are only proportional to the number
  49  *  of nonzero elements, and it provides a reasonably fast way to
  50  *  perform matrix-vector multiplications.
  51  *
  52  *  The data format is very similar to a neighborlist. It is optimized
  53  *  for fast access, but it is difficult to add entries. If you are
  54  *  constructing a matrix you should either do it in exactly the order
  55  *  specified here, or use some other more flexible intermediate structure.
  56  *
  57  *  The index array is of size nrow+1. All non-zero matrix elements
  58  *  on row i are stored in positions index[i] through index[i+1]-1 in
  59  *  the arrays column and value. The column array contains the column
  60  *  index for each entry, in ascending order, and the corresponding
  61  *  position in the value array contains the floating point matrix element.
  62  *
  63  *  index[nrow] should be equal to the total number of elements stored.
  64  *
  65  *  Thus, to find the value of matrix element [5,4] you should loop
  66  *  over positions index[5] to index[6]-1 in column until you either find
  67  *  the value 4, or a higher value (meaning the element was zero).
  68  *
  69  *  It is fairly easy to construct the matrix on-the-fly if you can do
  70  *  it row-by-row.
  71  *
  72  *  IMPORTANT:
  73  *  If compressed_symmetric is set to TRUE, you should only store EITHER the upper OR
  74  *  lower triangle (and the diagonal), and the other half is assumed to be
  75  *  symmetric. Otherwise, if compressed_symmetric==FALSE, no symmetry is implied and all
  76  *  elements should be stored.
  77  *
  78  *  The symmetry compression saves us a factor 2 both in storage and
  79  *  matrix multiplication CPU-time, which can be very useful for huge eigenproblems.
  80  *
  81  *  If you are unsure, just set compressed_symmetric to FALSE and list all elements. If
  82  *  you enable it but still list all elements (both upper and lower triangle) you will be sorry...
  83  *
  84  *  Internally, the sparse data is stored as a separate list for each row, where the list
  85  *  element is a structure with a column and (floating-point) data value. This makes it
  86  *  possible, although not completely transparent, to update values in random access order.
  87  *  The drawback is that the structure will allocate nrow memory regions.
  88  *  The matrix data could be stored in a single contiguous array with indices for each row,
  89  *  but then we could only insert elements at the end without copying the entire matrix.
  90  *
  91  *  After you have
  92  *
  93  *  In other words: Not perfect, but it works.
  94  */
  95
  96 typedef struct
  97 gmx_sparsematrix_entry
  98 {
  99     int      col;
 100     real     value;
 101 } gmx_sparsematrix_entry_t;
 102
 103 typedef struct
 104 gmx_sparsematrix
 105 {
 106     gmx_bool                         compressed_symmetric; /*!< Store half elements and assume symmetry. */
 107     int                          nrow;                 /*!< Number of rows in matrix                 */
 108     int *                        ndata;                /*!< Number of entries on each row (list)     */
 109     int *                        nalloc;               /*!< Allocated entry list length for each row */
 110     gmx_sparsematrix_entry_t **  data;                 /*!< data[i] is a list with entries on row i  */
 111 }
 112 gmx_sparsematrix_t;
 113
 114
 115 /*! \Allocate a new sparse matrix structure
 116  *
 117  *  The number of rows is used to allocate the index array entry. Obviously you
 118  *  can reallocate these later yourself if necessary - this is a
 119  *  convenience routine.
 120  *
 121  *  By default, the compressed_symmetric flag in the structure will
 122  *  be FALSE. Set it to TRUE manually if you are only storing either the
 123  *  upper or lower half of the matrix.
 124  */
 125 GMX_LIBGMX_EXPORT
 126 gmx_sparsematrix_t *
 127 gmx_sparsematrix_init            (int                    nrow);
 128
 129
 130 /*! \brief Release all resources used by a sparse matrix structure
 131  *
 132  *  All arrays in the structure will be freed, and the structure itself.
 133  */
 134 GMX_LIBGMX_EXPORT
 135 void
 136 gmx_sparsematrix_destroy         (gmx_sparsematrix_t *   A);
 137
 138
 139 /*! \brief Print sparse matrix to a stream.
 140  *
 141  *  Mainly used for debugging. Be warned that the real sparse matrices used
 142  *  in Gromacs runs can be HUGE (think 100,000 rows).
 143  */
 144 void
 145 gmx_sparsematrix_print           (FILE *                 stream,
 146                                   gmx_sparsematrix_t *   A);
 147
 148 /* Adds value at row,col. If the value did not exist
 149  * previously it is added, otherwise it is incremented with difference.
 150  *
 151  * The column sort order might change, so you need to run fix_sparsematrix
 152  * once you are done changing the matrix.
 153  */
 154 real
 155 gmx_sparsematrix_value          (gmx_sparsematrix_t *    A,
 156                                  int                     row,
 157                                  int                     col);
 158
 159
 160 /* Adds value at row,col. If the value did not exist
 161 * previously it is added, otherwise it is incremented with difference.
 162 *
 163 * The column sort order might change, so you need to run fix_sparsematrix
 164 * once you are done changing the matrix.
 165 */
 166 GMX_LIBGMX_EXPORT
 167 void
 168 gmx_sparsematrix_increment_value(gmx_sparsematrix_t *    A,
 169                                  int                     row,
 170                                  int                     col,
 171                                  real                    difference);
 172
 173
 174
 175 /*! \brief Sort elements in each column and remove zeros.
 176  *
 177  *  Sparse matrix access is faster when the elements are stored in
 178  *  increasing column order in each row. In some cases previously non-zero
 179  *  elements will be zero after adding more data, and this routine also removes
 180  *  those entries to reduce the storage requirements.
 181  *
 182  *  It never hurts to run this routine if you have been updating the matrix...
 183  */
 184 void
 185 gmx_sparsematrix_compress       (gmx_sparsematrix_t *    A);
 186
 187
 188
 189 /*! \brief Sparse matrix vector multiplication
 190  *
 191  * Calculate y = A * x for a sparse matrix A.
 192  */
 193 GMX_LIBGMX_EXPORT
 194 void
 195 gmx_sparsematrix_vector_multiply(gmx_sparsematrix_t *    A,
 196                                  real *                  x,
 197                                  real *                  y);
 198
 199 #ifdef __cplusplus
 200 }
 201 #endif
 202
 203
 204 #endif
 205
 206