src/tools/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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, 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 _EIGENSOLVER_H
  40 #define _EIGENSOLVER_H
  41
  42 #include "types/simple.h"
  43 #include "sparsematrix.h"
  44
  45
  46 /** Calculate eigenvalues/vectors a matrix stored in linear memory (not sparse).
  47  *
  48  *  This routine uses lapack to diagonalize a matrix efficiently, and
  49  *  the eigenvalues/vectors will be sorted in ascending order on output.
  50  *  Gromacs comes with a built-in portable BLAS/LAPACK, but if performance
  51  *  matters it is advisable to link with an optimized vendor-provided library.
  52  *
  53  *  \param a            Pointer to matrix data, total size n*n
  54  *                      The input data in the matrix will be destroyed/changed.
  55  *  \param n            Side of the matrix to calculate eigenvalues for.
  56  *  \param index_lower  Index of first eigenvector to determine.
  57  *  \param index_upper  Last eigenvector determined is index_upper-1.
  58  *  \param eigenvalues  Array of the eigenvalues on return. The length
  59  *                      of this array _must_ be n, even if not all
  60  *                      eigenvectors are calculated, since all eigenvalues
  61  *                      might be needed as an intermediate step.
  62  *  \param eigenvectors If this pointer is non-NULL, the eigenvectors
  63  *                      specified by the indices are returned as rows of
  64  *                      a matrix, i.e. eigenvector j starts at offset j*n, and
  65  *                      is of length n.
  66  */
  67 void
  68 eigensolver(real *   a,
  69             int      n,
  70             int      index_lower,
  71             int      index_upper,
  72             real *   eigenvalues,
  73             real *   eigenvec);
  74
  75
  76
  77 /*! \brief Sparse matrix eigensolver.
  78  *
  79  *  This routine is intended for large matrices that might not fit in memory.
  80  *
  81  *  It will determine the neig lowest eigenvalues, and if the eigenvectors pointer
  82  *  is non-NULL also the corresponding eigenvectors.
  83  *
  84  *  maxiter=100000 should suffice in most cases!
  85  */
  86 void
  87 sparse_eigensolver(gmx_sparsematrix_t *    A,
  88                    int                     neig,
  89                    real *                  eigenvalues,
  90                    real *                  eigenvectors,
  91                    int                     maxiter);
  92
  93
  94 #endif