#include <SymGEigsSolver.h>
Public Member Functions | |
SymGEigsSolver (OpType *op, BOpType *Bop, Index nev, Index ncv) | |
Public Member Functions inherited from Spectra::SymEigsBase< Scalar, SelectionRule, SymGEigsRegInvOp< Scalar, OpType, BOpType >, BOpType > | |
Index | compute (Index maxit=1000, Scalar tol=1e-10, int sort_rule=LARGEST_ALGE) |
Vector | eigenvalues () const |
virtual Matrix | eigenvectors (Index nvec) const |
virtual Matrix | eigenvectors () const |
int | info () const |
void | init (const Scalar *init_resid) |
void | init () |
Index | num_iterations () const |
Index | num_operations () const |
Private Types | |
typedef Eigen::Index | Index |
Additional Inherited Members | |
Protected Member Functions inherited from Spectra::SymEigsBase< Scalar, SelectionRule, SymGEigsRegInvOp< Scalar, OpType, BOpType >, BOpType > | |
virtual void | sort_ritzpair (int sort_rule) |
Protected Attributes inherited from Spectra::SymEigsBase< Scalar, SelectionRule, SymGEigsRegInvOp< Scalar, OpType, BOpType >, BOpType > | |
LanczosFac | m_fac |
const Index | m_n |
const Index | m_ncv |
const Index | m_nev |
Index | m_niter |
Index | m_nmatop |
SymGEigsRegInvOp< Scalar, OpType, BOpType > * | m_op |
Vector | m_ritz_val |
This class implements the generalized eigen solver for real symmetric matrices in the regular inverse mode, i.e., to solve where is symmetric, and is positive definite with the operations defined below.
This solver requires two matrix operation objects: one for that implements the matrix multiplication , and one for that implements the matrix-vector product and the linear equation solving operation .
If and are stored as Eigen matrices, then the first operation can be created using the DenseSymMatProd or SparseSymMatProd classes, and the second operation can be created using the SparseRegularInverse class. There is no wrapper class for a dense matrix since in this case the Cholesky mode is always preferred. If the users need to define their own operation classes, then they should implement all the public member functions as in those built-in classes.
Scalar | The element type of the matrix. Currently supported types are float , double and long double . |
SelectionRule | An enumeration value indicating the selection rule of the requested eigenvalues, for example LARGEST_MAGN to retrieve eigenvalues with the largest magnitude. The full list of enumeration values can be found in Enumerations. |
OpType | The name of the matrix operation class for . Users could either use the wrapper classes such as DenseSymMatProd and SparseSymMatProd, or define their own that implements all the public member functions as in DenseSymMatProd. |
BOpType | The name of the matrix operation class for . Users could either use the wrapper class SparseRegularInverse, or define their own that implements all the public member functions as in SparseRegularInverse. |
GEigsMode | Mode of the generalized eigen solver. In this solver it is Spectra::GEIGS_REGULAR_INVERSE. |
Definition at line 280 of file SymGEigsSolver.h.
|
private |
Definition at line 284 of file SymGEigsSolver.h.
|
inline |
Constructor to create a solver object.
op | Pointer to the matrix operation object. It should implement the matrix-vector multiplication operation of : calculating for any vector . Users could either create the object from the wrapper classes such as DenseSymMatProd, or define their own that implements all the public member functions as in DenseSymMatProd. |
Bop | Pointer to the matrix operation object. It should implement the multiplication operation and the linear equation solving operation for any vector . Users could either create the object from the wrapper class SparseRegularInverse, or define their own that implements all the public member functions as in SparseRegularInverse. |
nev | Number of eigenvalues requested. This should satisfy , where is the size of matrix. |
ncv | Parameter that controls the convergence speed of the algorithm. Typically a larger ncv means faster convergence, but it may also result in greater memory use and more matrix operations in each iteration. This parameter must satisfy , and is advised to take . |
Definition at line 310 of file SymGEigsSolver.h.