GQCP
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GQCP::GeneralizedEigenproblemEnvironment< _Scalar > Class Template Reference

#include <GeneralizedEigenproblemEnvironment.hpp>

Collaboration diagram for GQCP::GeneralizedEigenproblemEnvironment< _Scalar >:
Collaboration graph

Public Types

using Scalar = _Scalar
 

Public Member Functions

 GeneralizedEigenproblemEnvironment (const SquareMatrix< Scalar > &A, const SquareMatrix< Scalar > &S)
 
std::vector< Eigenpair< double, Scalar > > eigenpairs (const size_t number_of_requested_eigenpairs=1) const
 

Static Public Member Functions

static GeneralizedEigenproblemEnvironment Dense (const SquareMatrix< Scalar > &A, const SquareMatrix< Scalar > &S)
 

Public Attributes

SquareMatrix< ScalarA
 
SquareMatrix< ScalarS
 
VectorX< double > eigenvalues
 
MatrixX< Scalareigenvectors
 

Detailed Description

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

An environment used to solve generalized eigenvalue problems for matrices.

Template Parameters
_ScalarThe scalar type of the matrix elements: real or complex.

Member Typedef Documentation

◆ Scalar

template<typename _Scalar >
using GQCP::GeneralizedEigenproblemEnvironment< _Scalar >::Scalar = _Scalar

Constructor & Destructor Documentation

◆ GeneralizedEigenproblemEnvironment()

template<typename _Scalar >
GQCP::GeneralizedEigenproblemEnvironment< _Scalar >::GeneralizedEigenproblemEnvironment ( const SquareMatrix< Scalar > &  A,
const SquareMatrix< Scalar > &  S 
)
inline
Parameters
AThe matrix whose eigenvalue problem should be solved.

Member Function Documentation

◆ Dense()

template<typename _Scalar >
static GeneralizedEigenproblemEnvironment GQCP::GeneralizedEigenproblemEnvironment< _Scalar >::Dense ( const SquareMatrix< Scalar > &  A,
const SquareMatrix< Scalar > &  S 
)
inlinestatic
Parameters
AThe 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::GeneralizedEigenproblemEnvironment< _Scalar >::eigenpairs ( const size_t  number_of_requested_eigenpairs = 1) const
inline
Parameters
number_of_requested_eigenpairsThe number of eigenpairs to retrieve.
Returns
The eigenvalues and eigenvectors as a vector of eigenpairs.

Member Data Documentation

◆ A

template<typename _Scalar >
SquareMatrix<Scalar> GQCP::GeneralizedEigenproblemEnvironment< _Scalar >::A

◆ eigenvalues

template<typename _Scalar >
VectorX<double> GQCP::GeneralizedEigenproblemEnvironment< _Scalar >::eigenvalues

◆ eigenvectors

template<typename _Scalar >
MatrixX<Scalar> GQCP::GeneralizedEigenproblemEnvironment< _Scalar >::eigenvectors

◆ S

template<typename _Scalar >
SquareMatrix<Scalar> GQCP::GeneralizedEigenproblemEnvironment< _Scalar >::S

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