Solves subspace problem for linear eigenvalues and system of linear equations. More...

#include <SubspaceSolverLinEig.h>

Inheritance diagram for molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >:

[legend]

Collaboration diagram for molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >:

[legend]

Detailed Description

template<class RT, class QT, class PT>
class molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >

Solves subspace problem for linear eigenvalues and system of linear equations.

Public Types
using	value_type = typename ISubspaceSolver< RT, QT, PT >::value_type

using	value_type_abs = typename ISubspaceSolver< RT, QT, PT >::value_type_abs

using	R = typename ISubspaceSolver< RT, QT, PT >::R

using	Q = typename ISubspaceSolver< RT, QT, PT >::Q

using	P = typename ISubspaceSolver< RT, QT, PT >::P

Public Types inherited from molpro::linalg::itsolv::subspace::ISubspaceSolver< RT, QT, PT >
using	R = RT

using	Q = QT

using	P = PT

using	value_type = typename array::ArrayHandler< R, R >::value_type

using	value_type_abs = typename array::ArrayHandler< R, R >::value_type_abs

Public Member Functions
	SubspaceSolverLinEig (std::shared_ptr< Logger > logger)

void	solve (IXSpace< R, Q, P > &xspace, const size_t nroots_max) override
	Solve the subspace problem. More...

void	set_error (int root, value_type_abs error) override
	Set error value for solution root More...

void	set_error (const std::vector< int > &roots, const std::vector< value_type_abs > &errors) override
	Update errors for a group of roots. More...

const Matrix< value_type > &	solutions () const override
	Access solutions from the last solve() call. More...

const std::vector< value_type > &	eigenvalues () const override
	Access eigenvalues from the last solve() call. More...

const std::vector< value_type_abs > &	errors () const override
	Access errors corresponding to each solution. More...

size_t	size () const override
	Number of solutions. More...

void	set_hermiticity (bool hermitian)
	Set Hermiticity of the subspace. More...

bool	get_hermiticity ()

void	set_augmented_hessian (double parameter)
	Set value of augmented hessian parameter. If 0, than augmented Hessian is not used. More...

double	get_augmented_hessian ()

Public Member Functions inherited from molpro::linalg::itsolv::subspace::ISubspaceSolver< RT, QT, PT >
virtual	~ISubspaceSolver ()=default

virtual void	solve (IXSpace< R, Q, P > &xspace, size_t nroots_max)=0
	Solve the subspace problem. More...

virtual void	set_error (int root, value_type_abs error)=0
	Update the error associated with a given root. More...

virtual void	set_error (const std::vector< int > &roots, const std::vector< value_type_abs > &errors)=0
	Update errors for a group of roots. More...

virtual const Matrix< value_type > &	solutions () const =0
	Access solutions from the last solve() call. More...

virtual const std::vector< value_type > &	eigenvalues () const =0
	Access eigenvalues from the last solve() call. More...

virtual const std::vector< value_type_abs > &	errors () const =0
	Access errors corresponding to each solution. More...

virtual size_t	size () const =0
	Number of solutions stored in this object. More...

Public Attributes
value_type_abs	m_svd_solver_threshold = 1.0e-14
	threshold to select null space during SVD in eigenproblem More...

Protected Member Functions
void	solve_eigenvalue (IXSpace< R, Q, P > &xspace, const size_t nroots_max)

void	solve_linear_equations (IXSpace< R, Q, P > &xspace)

Protected Attributes
Matrix< value_type >	m_solutions
	solution matrix with row vectors More...

std::vector< value_type >	m_eigenvalues
	eigenvalues More...

std::vector< value_type_abs >	m_errors
	errors in subspace solutions More...

std::shared_ptr< Logger >	m_logger {}

bool	m_hermitian = false
	flags the matrix as Hermitian More...

double	m_augmented_hessian = 0
	value of augmented hessian parameter. If 0, than augmented Hessian is not used More...

Member Typedef Documentation

◆ P

template<class RT , class QT , class PT >

using molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::P = typename ISubspaceSolver<RT, QT, PT>::P

◆ Q

template<class RT , class QT , class PT >

using molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::Q = typename ISubspaceSolver<RT, QT, PT>::Q

◆ R

template<class RT , class QT , class PT >

using molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::R = typename ISubspaceSolver<RT, QT, PT>::R

◆ value_type

template<class RT , class QT , class PT >

using molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::value_type = typename ISubspaceSolver<RT, QT, PT>::value_type

◆ value_type_abs

template<class RT , class QT , class PT >

using molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::value_type_abs = typename ISubspaceSolver<RT, QT, PT>::value_type_abs

Constructor & Destructor Documentation

◆ SubspaceSolverLinEig()

template<class RT , class QT , class PT >

molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::SubspaceSolverLinEig ( std::shared_ptr< Logger > logger )

inlineexplicit

Member Function Documentation

◆ eigenvalues()

template<class RT , class QT , class PT >

const std::vector< value_type > & molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::eigenvalues ( ) const

inlineoverridevirtual

Access eigenvalues from the last solve() call.

Implements molpro::linalg::itsolv::subspace::ISubspaceSolver< RT, QT, PT >.

◆ errors()

template<class RT , class QT , class PT >

const std::vector< value_type_abs > & molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::errors ( ) const

inlineoverridevirtual

Access errors corresponding to each solution.

Implements molpro::linalg::itsolv::subspace::ISubspaceSolver< RT, QT, PT >.

◆ get_augmented_hessian()

template<class RT , class QT , class PT >

double molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::get_augmented_hessian ( )

inline

◆ get_hermiticity()

template<class RT , class QT , class PT >

bool molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::get_hermiticity ( )

inline

◆ set_augmented_hessian()

template<class RT , class QT , class PT >

void molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::set_augmented_hessian ( double parameter )

inline

Set value of augmented hessian parameter. If 0, than augmented Hessian is not used.

◆ set_error() [1/2]

template<class RT , class QT , class PT >

void molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::set_error	(	const std::vector< int > &	roots,
		const std::vector< value_type_abs > &	errors
	)

inlineoverridevirtual

Update errors for a group of roots.

Parameters

roots	group of roots
errors	errors corresponding to each root

Implements molpro::linalg::itsolv::subspace::ISubspaceSolver< RT, QT, PT >.

◆ set_error() [2/2]

template<class RT , class QT , class PT >

void molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::set_error	(	int	root,
		value_type_abs	error
	)

inlineoverridevirtual

Set error value for solution root

Implements molpro::linalg::itsolv::subspace::ISubspaceSolver< RT, QT, PT >.

◆ set_hermiticity()

template<class RT , class QT , class PT >

void molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::set_hermiticity ( bool hermitian )

inline

Set Hermiticity of the subspace.

◆ size()

template<class RT , class QT , class PT >

size_t molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::size ( ) const

inlineoverridevirtual

Number of solutions.

Implements molpro::linalg::itsolv::subspace::ISubspaceSolver< RT, QT, PT >.

◆ solutions()

template<class RT , class QT , class PT >

const Matrix< value_type > & molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::solutions ( ) const

inlineoverridevirtual

Access solutions from the last solve() call.

Implements molpro::linalg::itsolv::subspace::ISubspaceSolver< RT, QT, PT >.

◆ solve()

template<class RT , class QT , class PT >

void molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::solve	(	IXSpace< R, Q, P > &	xspace,
		const size_t	nroots_max
	)

inlineoverridevirtual

Solve the subspace problem.

Parameters

xspace	definition of the subspace
nroots_max	maximum number of roots to calculate

Implements molpro::linalg::itsolv::subspace::ISubspaceSolver< RT, QT, PT >.

Reimplemented in molpro::linalg::itsolv::subspace::SubspaceSolverRSPT< RT, QT, PT >.

◆ solve_eigenvalue()

template<class RT , class QT , class PT >

void molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::solve_eigenvalue	(	IXSpace< R, Q, P > &	xspace,
		const size_t	nroots_max
	)

inlineprotected

◆ solve_linear_equations()

template<class RT , class QT , class PT >

void molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::solve_linear_equations ( IXSpace< R, Q, P > & xspace )

inlineprotected

Member Data Documentation

◆ m_augmented_hessian

template<class RT , class QT , class PT >

double molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::m_augmented_hessian = 0

protected

value of augmented hessian parameter. If 0, than augmented Hessian is not used

◆ m_eigenvalues

template<class RT , class QT , class PT >

std::vector<value_type> molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::m_eigenvalues

protected

eigenvalues

◆ m_errors

template<class RT , class QT , class PT >

std::vector<value_type_abs> molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::m_errors

protected

errors in subspace solutions

◆ m_hermitian

template<class RT , class QT , class PT >

bool molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::m_hermitian = false

protected

flags the matrix as Hermitian

◆ m_logger

template<class RT , class QT , class PT >

std::shared_ptr<Logger> molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::m_logger {}

protected

◆ m_solutions

template<class RT , class QT , class PT >

Matrix<value_type> molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::m_solutions

protected

solution matrix with row vectors

◆ m_svd_solver_threshold

template<class RT , class QT , class PT >

value_type_abs molpro::linalg::itsolv::subspace::SubspaceSolverLinEig< RT, QT, PT >::m_svd_solver_threshold = 1.0e-14

threshold to select null space during SVD in eigenproblem

Detailed Description

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ P

◆ Q

◆ R

◆ value_type

◆ value_type_abs

Constructor & Destructor Documentation

◆ SubspaceSolverLinEig()

Member Function Documentation

◆ eigenvalues()

◆ errors()

◆ get_augmented_hessian()

◆ get_hermiticity()

◆ set_augmented_hessian()

◆ set_error() [1/2]

◆ set_error() [2/2]

◆ set_hermiticity()

◆ size()

◆ solutions()

◆ solve()

◆ solve_eigenvalue()

◆ solve_linear_equations()

Member Data Documentation

◆ m_augmented_hessian

◆ m_eigenvalues

◆ m_errors

◆ m_hermitian

◆ m_logger

◆ m_solutions

◆ m_svd_solver_threshold