template<typename Scalar, int SelectionRule, typename OpType, typename BOpType>
class Spectra::SymGEigsSolver< Scalar, SelectionRule, OpType, BOpType, GEIGS_REGULAR_INVERSE >
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.
- Template Parameters
-
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.