src/gromacs/linearalgebra/eigensolver.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  * Copyright (c) 2012,2014, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_LINEARALGEBRA_EIGENSOLVER_H
  38 #define GMX_LINEARALGEBRA_EIGENSOLVER_H
  39
  40 #include "gromacs/linearalgebra/sparsematrix.h"
  41 #include "gromacs/utility/real.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /** Calculate eigenvalues/vectors a matrix stored in linear memory (not sparse).
  48  *
  49  *  This routine uses lapack to diagonalize a matrix efficiently, and
  50  *  the eigenvalues/vectors will be sorted in ascending order on output.
  51  *  Gromacs comes with a built-in portable BLAS/LAPACK, but if performance
  52  *  matters it is advisable to link with an optimized vendor-provided library.
  53  *
  54  *  \param a            Pointer to matrix data, total size n*n
  55  *                      The input data in the matrix will be destroyed/changed.
  56  *  \param n            Side of the matrix to calculate eigenvalues for.
  57  *  \param index_lower  Index of first eigenvector to determine.
  58  *  \param index_upper  Last eigenvector determined is index_upper-1.
  59  *  \param eigenvalues  Array of the eigenvalues on return. The length
  60  *                      of this array _must_ be n, even if not all
  61  *                      eigenvectors are calculated, since all eigenvalues
  62  *                      might be needed as an intermediate step.
  63  *  \param eigenvec     If this pointer is non-NULL, the eigenvectors
  64  *                      specified by the indices are returned as rows of
  65  *                      a matrix, i.e. eigenvector j starts at offset j*n, and
  66  *                      is of length n.
  67  */
  68 void
  69 eigensolver(real *   a,
  70             int      n,
  71             int      index_lower,
  72             int      index_upper,
  73             real *   eigenvalues,
  74             real *   eigenvec);
  75
  76
  77
  78 /*! \brief Sparse matrix eigensolver.
  79  *
  80  *  This routine is intended for large matrices that might not fit in memory.
  81  *
  82  *  It will determine the neig lowest eigenvalues, and if the eigenvectors pointer
  83  *  is non-NULL also the corresponding eigenvectors.
  84  *
  85  *  maxiter=100000 should suffice in most cases!
  86  */
  87 void
  88 sparse_eigensolver(gmx_sparsematrix_t *    A,
  89                    int                     neig,
  90                    real *                  eigenvalues,
  91                    real *                  eigenvectors,
  92                    int                     maxiter);
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif
  97
  98 #endif