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

#include <GeneralizedDenseDiagonalization.hpp>

Inheritance diagram for GQCP::GeneralizedDenseDiagonalization< _Scalar >:
Inheritance graph
Collaboration diagram for GQCP::GeneralizedDenseDiagonalization< _Scalar >:
Collaboration graph

Public Types

using Scalar = _Scalar
 
- Public Types inherited from GQCP::Step< GeneralizedEigenproblemEnvironment< _Scalar > >
using Environment = GeneralizedEigenproblemEnvironment< _Scalar >
 

Public Member Functions

std::string description () const override
 
void execute (GeneralizedEigenproblemEnvironment< Scalar > &environment) override
 
- Public Member Functions inherited from GQCP::Step< GeneralizedEigenproblemEnvironment< _Scalar > >
virtual ~Step ()=default
 
virtual std::string description () const=0
 
virtual void execute (Environment &environment)=0
 

Detailed Description

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

A step that performs a dense generalized diagonalization.

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

Member Typedef Documentation

◆ Scalar

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

Member Function Documentation

◆ description()

template<typename _Scalar >
std::string GQCP::GeneralizedDenseDiagonalization< _Scalar >::description ( ) const
inlineoverridevirtual

MARK: Overridden methods

Returns
A textual description of this algorithmic step.

Implements GQCP::Step< GeneralizedEigenproblemEnvironment< _Scalar > >.

◆ execute()

template<typename _Scalar >
void GQCP::GeneralizedDenseDiagonalization< _Scalar >::execute ( GeneralizedEigenproblemEnvironment< Scalar > &  environment)
inlineoverridevirtual

Read the matrix from the environment, diagonalize it and write the number of requested eigenpairs to it.

Parameters
environmentThe environment that this step can read from and write to.

Implements GQCP::Step< GeneralizedEigenproblemEnvironment< _Scalar > >.


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