Spectra::JDSymEigsBase< Derived, OpType > Class Template Reference

#include <Spectra/JDSymEigsBase.h>

Public Member Functions
	JDSymEigsBase (OpType &op, Index nev, Index nvec_init, Index nvec_max)
	JDSymEigsBase (OpType &op, Index nev)
void	set_max_search_space_size (Index max_search_space_size)
void	set_correction_size (Index correction_size)
void	set_initial_search_space_size (Index initial_search_space_size)
virtual	~JDSymEigsBase ()
CompInfo	info () const
Index	num_iterations () const
Vector	eigenvalues () const
Matrix	eigenvectors () const
Index	compute (SortRule selection=SortRule::LargestMagn, Index maxit=100, Scalar tol=100 *Eigen::NumTraits< Scalar >::dummy_precision())
Index	compute_with_guess (const Eigen::Ref< const Matrix > &initial_space, SortRule selection=SortRule::LargestMagn, Index maxit=100, Scalar tol=100 *Eigen::NumTraits< Scalar >::dummy_precision())

Detailed Description

template<typename Derived, typename OpType>
class Spectra::JDSymEigsBase< Derived, OpType >

This is the base class for symmetric JD eigen solvers, mainly for internal use. It is kept here to provide the documentation for member functions of concrete eigen solvers such as DavidsonSymEigsSolver.

This class uses the CRTP method to call functions from the derived class.

Definition at line 34 of file JDSymEigsBase.h.

Constructor & Destructor Documentation

~JDSymEigsBase()

template<typename Derived , typename OpType >

virtual Spectra::JDSymEigsBase< Derived, OpType >::~JDSymEigsBase ( )

inlinevirtual

Virtual destructor

Definition at line 116 of file JDSymEigsBase.h.

Member Function Documentation

set_max_search_space_size()

template<typename Derived , typename OpType >

void Spectra::JDSymEigsBase< Derived, OpType >::set_max_search_space_size ( Index  max_search_space_size )

inline

Sets the Maxmium SearchspaceSize after which is deflated

Definition at line 93 of file JDSymEigsBase.h.

set_correction_size()

template<typename Derived , typename OpType >

void Spectra::JDSymEigsBase< Derived, OpType >::set_correction_size ( Index  correction_size )

inline

Sets how many correction vectors are added in each iteration

Definition at line 100 of file JDSymEigsBase.h.

set_initial_search_space_size()

template<typename Derived , typename OpType >

void Spectra::JDSymEigsBase< Derived, OpType >::set_initial_search_space_size ( Index  initial_search_space_size )

inline

Sets the Initial SearchspaceSize for Ritz values

Definition at line 108 of file JDSymEigsBase.h.

info()

template<typename Derived , typename OpType >

CompInfo Spectra::JDSymEigsBase< Derived, OpType >::info ( ) const

inline

Returns the status of the computation. The full list of enumeration values can be found in Enumerations.

Definition at line 122 of file JDSymEigsBase.h.

num_iterations()

template<typename Derived , typename OpType >

Index Spectra::JDSymEigsBase< Derived, OpType >::num_iterations ( ) const

inline

Returns the number of iterations used in the computation.

Definition at line 127 of file JDSymEigsBase.h.

---

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

• Spectra/JDSymEigsBase.h