#include <JDSymEigsBase.h>

Public Member Functions
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())

Vector	eigenvalues () const

Matrix	eigenvectors () const

CompInfo	info () const

	JDSymEigsBase (OpType &op, Index nev)

	JDSymEigsBase (OpType &op, Index nev, Index nvec_init, Index nvec_max)

Index	num_iterations () const

void	set_correction_size (Index correction_size)

void	set_initial_search_space_size (Index initial_search_space_size)

void	set_max_search_space_size (Index max_search_space_size)

virtual	~JDSymEigsBase ()

Protected Types
using	Index = Eigen::Index

using	Matrix = Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic >

using	Scalar = typename OpType::Scalar

using	Vector = Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >

Protected Attributes
Index	m_correction_size

Index	m_initial_search_space_size

const OpType &	m_matrix_operator

Index	m_max_search_space_size

const Index	m_number_eigenvalues

RitzPairs< Scalar >	m_ritz_pairs

SearchSpace< Scalar >	m_search_space

Index	niter_ = 0

Private Member Functions
void	check_argument () const

void	initialize ()

Private Attributes
CompInfo	m_info = CompInfo::NotComputed

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.

Member Typedef Documentation

◆ Index

template<typename Derived , typename OpType >

using Spectra::JDSymEigsBase< Derived, OpType >::Index = Eigen::Index

protected

Definition at line 37 of file JDSymEigsBase.h.

◆ Matrix

template<typename Derived , typename OpType >

using Spectra::JDSymEigsBase< Derived, OpType >::Matrix = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>

protected

Definition at line 39 of file JDSymEigsBase.h.

◆ Scalar

template<typename Derived , typename OpType >

using Spectra::JDSymEigsBase< Derived, OpType >::Scalar = typename OpType::Scalar

protected

Definition at line 38 of file JDSymEigsBase.h.

◆ Vector

template<typename Derived , typename OpType >

using Spectra::JDSymEigsBase< Derived, OpType >::Vector = Eigen::Matrix<Scalar, Eigen::Dynamic, 1>

protected

Definition at line 40 of file JDSymEigsBase.h.

Constructor & Destructor Documentation

◆ JDSymEigsBase() [1/2]

template<typename Derived , typename OpType >

Spectra::JDSymEigsBase< Derived, OpType >::JDSymEigsBase	(	OpType &	op,
		Index	nev,
		Index	nvec_init,
		Index	nvec_max
	)

inline

Definition at line 76 of file JDSymEigsBase.h.

◆ JDSymEigsBase() [2/2]

template<typename Derived , typename OpType >

Spectra::JDSymEigsBase< Derived, OpType >::JDSymEigsBase	(	OpType &	op,
		Index	nev
	)

inline

Definition at line 87 of file JDSymEigsBase.h.

◆ ~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

◆ check_argument()

template<typename Derived , typename OpType >

void Spectra::JDSymEigsBase< Derived, OpType >::check_argument ( ) const

inlineprivate

Definition at line 55 of file JDSymEigsBase.h.

◆ compute()

template<typename Derived , typename OpType >

Index Spectra::JDSymEigsBase< Derived, OpType >::compute	(	SortRule	selection = `SortRule::LargestMagn`,
		Index	maxit = `100`,
		Scalar	tol = `100 * Eigen::NumTraits<Scalar>::dummy_precision()`
	)

inline

Definition at line 133 of file JDSymEigsBase.h.

◆ compute_with_guess()

template<typename Derived , typename OpType >

Index Spectra::JDSymEigsBase< Derived, OpType >::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()`
	)

inline

Definition at line 141 of file JDSymEigsBase.h.

◆ eigenvalues()

template<typename Derived , typename OpType >

Vector Spectra::JDSymEigsBase< Derived, OpType >::eigenvalues ( ) const

inline

Definition at line 129 of file JDSymEigsBase.h.

◆ eigenvectors()

template<typename Derived , typename OpType >

Matrix Spectra::JDSymEigsBase< Derived, OpType >::eigenvectors ( ) const

inline

Definition at line 131 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.

◆ initialize()

template<typename Derived , typename OpType >

void Spectra::JDSymEigsBase< Derived, OpType >::initialize ( )

inlineprivate

Definition at line 61 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.

◆ 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.

◆ 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.

Member Data Documentation

◆ m_correction_size

template<typename Derived , typename OpType >

Index Spectra::JDSymEigsBase< Derived, OpType >::m_correction_size

protected

Definition at line 48 of file JDSymEigsBase.h.

◆ m_info

template<typename Derived , typename OpType >

CompInfo Spectra::JDSymEigsBase< Derived, OpType >::m_info = CompInfo::NotComputed

private

Definition at line 53 of file JDSymEigsBase.h.

◆ m_initial_search_space_size

template<typename Derived , typename OpType >

Index Spectra::JDSymEigsBase< Derived, OpType >::m_initial_search_space_size

protected

Definition at line 47 of file JDSymEigsBase.h.

◆ m_matrix_operator

template<typename Derived , typename OpType >

const OpType& Spectra::JDSymEigsBase< Derived, OpType >::m_matrix_operator

protected

Definition at line 42 of file JDSymEigsBase.h.

◆ m_max_search_space_size

template<typename Derived , typename OpType >

Index Spectra::JDSymEigsBase< Derived, OpType >::m_max_search_space_size

protected

Definition at line 46 of file JDSymEigsBase.h.

◆ m_number_eigenvalues

template<typename Derived , typename OpType >

const Index Spectra::JDSymEigsBase< Derived, OpType >::m_number_eigenvalues

protected

Definition at line 45 of file JDSymEigsBase.h.

◆ m_ritz_pairs

template<typename Derived , typename OpType >

RitzPairs<Scalar> Spectra::JDSymEigsBase< Derived, OpType >::m_ritz_pairs

protected

Definition at line 49 of file JDSymEigsBase.h.

◆ m_search_space

template<typename Derived , typename OpType >

SearchSpace<Scalar> Spectra::JDSymEigsBase< Derived, OpType >::m_search_space

protected

Definition at line 50 of file JDSymEigsBase.h.

◆ niter_

template<typename Derived , typename OpType >

Index Spectra::JDSymEigsBase< Derived, OpType >::niter_ = 0

protected

Definition at line 44 of file JDSymEigsBase.h.

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

JDSymEigsBase.h

Public Member Functions

Protected Types

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Index

◆ Matrix

◆ Scalar

◆ Vector

Constructor & Destructor Documentation

◆ JDSymEigsBase() [1/2]

◆ JDSymEigsBase() [2/2]

◆ ~JDSymEigsBase()

Member Function Documentation

◆ check_argument()

◆ compute()

◆ compute_with_guess()

◆ eigenvalues()

◆ eigenvectors()

◆ info()

◆ initialize()

◆ num_iterations()

◆ set_correction_size()

◆ set_initial_search_space_size()

◆ set_max_search_space_size()

Member Data Documentation

◆ m_correction_size

◆ m_info

◆ m_initial_search_space_size

◆ m_matrix_operator

◆ m_max_search_space_size

◆ m_number_eigenvalues

◆ m_ritz_pairs

◆ m_search_space

◆ niter_

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