#include <EigenproblemEnvironment.hpp>

Collaboration diagram for GQCP::EigenproblemEnvironment< _Scalar >:

Public Types
using	Scalar = _Scalar

Public Member Functions
	EigenproblemEnvironment (const SquareMatrix< Scalar > &A)

	EigenproblemEnvironment (const VectorFunction< Scalar > &matrix_vector_product_function, const VectorX< Scalar > &diagonal, const MatrixX< Scalar > &V)

std::vector< Eigenpair< double, Scalar > >	eigenpairs (const size_t number_of_requested_eigenpairs=1) const

Static Public Member Functions
static EigenproblemEnvironment	Dense (const SquareMatrix< Scalar > &A)

static EigenproblemEnvironment	Iterative (const VectorFunction< Scalar > &matrix_vector_product_function, const VectorX< Scalar > &diagonal, const MatrixX< Scalar > &V)

static EigenproblemEnvironment	Iterative (const SquareMatrix< Scalar > &A, const MatrixX< Scalar > &V)

Public Attributes
VectorFunction< Scalar >	matrix_vector_product_function

SquareMatrix< Scalar >	A

VectorX< Scalar >	diagonal

size_t	dimension

VectorX< double >	eigenvalues

MatrixX< Scalar >	eigenvectors

SquareMatrix< Scalar >	S

VectorX< double >	Lambda

MatrixX< Scalar >	Z

MatrixX< Scalar >	V

MatrixX< Scalar >	VA

MatrixX< Scalar >	X

MatrixX< Scalar >	R

MatrixX< Scalar >	Delta

Detailed Description

template<typename _Scalar>
class GQCP::EigenproblemEnvironment< _Scalar >

An environment used to solve eigenvalue problems for self-adjoint matrices.

Template Parameters

_Scalar The scalar type of the matrix elements: real or complex.

Member Typedef Documentation

◆ Scalar

template<typename _Scalar >

using GQCP::EigenproblemEnvironment< _Scalar >::Scalar = _Scalar

Constructor & Destructor Documentation

◆ EigenproblemEnvironment() [1/2]

template<typename _Scalar >

GQCP::EigenproblemEnvironment< _Scalar >::EigenproblemEnvironment ( const SquareMatrix< Scalar > & A )

inline

Parameters

A	The matrix whose eigenvalue problem should be solved.

◆ EigenproblemEnvironment() [2/2]

template<typename _Scalar >

GQCP::EigenproblemEnvironment< _Scalar >::EigenproblemEnvironment	(	const VectorFunction< Scalar > &	matrix_vector_product_function,
		const VectorX< Scalar > &	diagonal,
		const MatrixX< Scalar > &	V
	)

inline

Parameters

matrix_vector_product	A vector function that returns the matrix-vector product (i.e. the matrix-vector product representation of the matrix).
diagonal	The diagonal of the matrix whose eigenvalue problem should be solved.

Member Function Documentation

◆ Dense()

template<typename _Scalar >

static EigenproblemEnvironment GQCP::EigenproblemEnvironment< _Scalar >::Dense ( const SquareMatrix< Scalar > & A )

inlinestatic

Parameters

A	The matrix whose eigenvalue problem should be solved.

Returns: An environment that can be used to solve the dense eigenvalue problem for the given square matrix.

◆ eigenpairs()

template<typename _Scalar >

std::vector< Eigenpair< double, Scalar > > GQCP::EigenproblemEnvironment< _Scalar >::eigenpairs ( const size_t number_of_requested_eigenpairs = 1 ) const

inline

Parameters

number_of_requested_eigenpairs The number of eigenpairs to retrieve.

Returns: The eigenvalues and eigenvectors as a vector of eigenpairs.

◆ Iterative() [1/2]

template<typename _Scalar >

static EigenproblemEnvironment GQCP::EigenproblemEnvironment< _Scalar >::Iterative	(	const SquareMatrix< Scalar > &	A,
		const MatrixX< Scalar > &	V
	)

inlinestatic

Parameters

A	The matrix whose eigenvalue problem should be solved.
V	A matrix of initial guess vectors (each column of the matrix is an initial guess vector).

Returns: An environment that can be used to solve the eigenvalue problem for the matrix that is represented by the given matrix-vector product.

◆ Iterative() [2/2]

template<typename _Scalar >

static EigenproblemEnvironment GQCP::EigenproblemEnvironment< _Scalar >::Iterative	(	const VectorFunction< Scalar > &	matrix_vector_product_function,
		const VectorX< Scalar > &	diagonal,
		const MatrixX< Scalar > &	V
	)

inlinestatic

Parameters

matrix_vector_product	A vector function that returns the matrix-vector product (i.e. the matrix-vector product representation of the matrix).
diagonal	The diagonal of the matrix whose eigenvalue problem should be solved.
V	A matrix of initial guess vectors (each column of the matrix is an initial guess vector).