Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
Spectra::GenEigsRealShiftSolver< OpType > Class Template Reference
Eigen Solvers

#include <GenEigsRealShiftSolver.h>

Inheritance diagram for Spectra::GenEigsRealShiftSolver< OpType >:
Inheritance graph
[legend]

Public Member Functions

 GenEigsRealShiftSolver (OpType &op, Index nev, Index ncv, const Scalar &sigma)
 
- Public Member Functions inherited from Spectra::GenEigsBase< DenseGenRealShiftSolve< double >, IdentityBOp >
Index compute (SortRule selection=SortRule::LargestMagn, Index maxit=1000, Scalar tol=1e-10, SortRule sorting=SortRule::LargestMagn)
 
ComplexVector eigenvalues () const
 
ComplexMatrix eigenvectors () const
 
ComplexMatrix eigenvectors (Index nvec) const
 
CompInfo info () const
 
void init ()
 
void init (const Scalar *init_resid)
 
Index num_iterations () const
 
Index num_operations () const
 

Private Types

using Base = GenEigsBase< OpType, IdentityBOp >
 
using Complex = std::complex< Scalar >
 
using ComplexArray = Eigen::Array< Complex, Eigen::Dynamic, 1 >
 
using Index = Eigen::Index
 
using Scalar = typename OpType::Scalar
 

Private Member Functions

void sort_ritzpair (SortRule sort_rule) override
 

Private Attributes

const Index m_nev
 
ComplexVector m_ritz_val
 
const Scalar m_sigma
 

Additional Inherited Members

- Protected Attributes inherited from Spectra::GenEigsBase< DenseGenRealShiftSolve< double >, IdentityBOp >
ArnoldiFac m_fac
 
const Index m_n
 
const Index m_ncv
 
const Index m_nev
 
Index m_niter
 
Index m_nmatop
 
DenseGenRealShiftSolve< double > & m_op
 
ComplexVector m_ritz_est
 
ComplexVector m_ritz_val
 
ComplexMatrix m_ritz_vec
 

Detailed Description

template<typename OpType = DenseGenRealShiftSolve<double>>
class Spectra::GenEigsRealShiftSolver< OpType >

This class implements the eigen solver for general real matrices with a real shift value in the shift-and-invert mode. The background knowledge of the shift-and-invert mode can be found in the documentation of the SymEigsShiftSolver class.

Template Parameters
OpTypeThe name of the matrix operation class. Users could either use the wrapper classes such as DenseGenRealShiftSolve and SparseGenRealShiftSolve, or define their own that implements the type definition Scalar and all the public member functions as in DenseGenRealShiftSolve.

Definition at line 33 of file GenEigsRealShiftSolver.h.

Member Typedef Documentation

◆ Base

template<typename OpType = DenseGenRealShiftSolve<double>>
using Spectra::GenEigsRealShiftSolver< OpType >::Base = GenEigsBase<OpType, IdentityBOp>
private

Definition at line 41 of file GenEigsRealShiftSolver.h.

◆ Complex

template<typename OpType = DenseGenRealShiftSolve<double>>
using Spectra::GenEigsRealShiftSolver< OpType >::Complex = std::complex<Scalar>
private

Definition at line 38 of file GenEigsRealShiftSolver.h.

◆ ComplexArray

template<typename OpType = DenseGenRealShiftSolve<double>>
using Spectra::GenEigsRealShiftSolver< OpType >::ComplexArray = Eigen::Array<Complex, Eigen::Dynamic, 1>
private

Definition at line 39 of file GenEigsRealShiftSolver.h.

◆ Index

template<typename OpType = DenseGenRealShiftSolve<double>>
using Spectra::GenEigsRealShiftSolver< OpType >::Index = Eigen::Index
private

Definition at line 37 of file GenEigsRealShiftSolver.h.

◆ Scalar

template<typename OpType = DenseGenRealShiftSolve<double>>
using Spectra::GenEigsRealShiftSolver< OpType >::Scalar = typename OpType::Scalar
private

Definition at line 36 of file GenEigsRealShiftSolver.h.

Constructor & Destructor Documentation

◆ GenEigsRealShiftSolver()

template<typename OpType = DenseGenRealShiftSolve<double>>
Spectra::GenEigsRealShiftSolver< OpType >::GenEigsRealShiftSolver ( OpType &  op,
Index  nev,
Index  ncv,
const Scalar &  sigma 
)
inline

Constructor to create a eigen solver object using the shift-and-invert mode.

Parameters
opThe matrix operation object that implements the shift-solve operation of $A$: calculating $(A-\sigma I)^{-1}v$ for any vector $v$. Users could either create the object from the wrapper class such as DenseGenRealShiftSolve, or define their own that implements all the public members as in DenseGenRealShiftSolve.
nevNumber of eigenvalues requested. This should satisfy $1\le nev \le n-2$, where $n$ is the size of matrix.
ncvParameter 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 $nev+2 \le ncv \le n$, and is advised to take $ncv \ge 2\cdot nev + 1$.
sigmaThe real-valued shift.

Definition at line 75 of file GenEigsRealShiftSolver.h.

Member Function Documentation

◆ sort_ritzpair()

template<typename OpType = DenseGenRealShiftSolve<double>>
void Spectra::GenEigsRealShiftSolver< OpType >::sort_ritzpair ( SortRule  sort_rule)
inlineoverrideprivatevirtual

Reimplemented from Spectra::GenEigsBase< DenseGenRealShiftSolve< double >, IdentityBOp >.

Definition at line 48 of file GenEigsRealShiftSolver.h.

Member Data Documentation

◆ m_nev

template<typename OpType = DenseGenRealShiftSolve<double>>
const Index Spectra::GenEigsBase< OpType, BOpType >::m_nev
private

Definition at line 63 of file GenEigsBase.h.

◆ m_ritz_val

template<typename OpType = DenseGenRealShiftSolve<double>>
ComplexVector Spectra::GenEigsBase< OpType, BOpType >::m_ritz_val
private

Definition at line 70 of file GenEigsBase.h.

◆ m_sigma

template<typename OpType = DenseGenRealShiftSolve<double>>
const Scalar Spectra::GenEigsRealShiftSolver< OpType >::m_sigma
private

Definition at line 45 of file GenEigsRealShiftSolver.h.

The documentation for this class was generated from the following file:

gtsam
Author(s):
autogenerated on Wed May 28 2025 03:15:49