#include <ConvergenceCriterion.hpp>
Inheritance diagram for GQCP::ConvergenceCriterion< _Environment >:
Collaboration diagram for GQCP::ConvergenceCriterion< _Environment >:
Public Types | |
| using | Environment = _Environment |
Public Member Functions | |
| virtual | ~ConvergenceCriterion ()=default |
| virtual std::string | description () const =0 |
| virtual bool | isFulfilled (Environment &environment)=0 |
Detailed Description
template<typename _Environment>
class GQCP::ConvergenceCriterion< _Environment >
class GQCP::ConvergenceCriterion< _Environment >
A criterion that can check convergence by examining certain properties of the environment.
- Template Parameters
-
_Environment the type of the environment that this criterion can read from
Member Typedef Documentation
◆ Environment
template<typename _Environment >
| using GQCP::ConvergenceCriterion< _Environment >::Environment = _Environment |
Constructor & Destructor Documentation
◆ ~ConvergenceCriterion()
template<typename _Environment >
|
virtualdefault |
Member Function Documentation
◆ description()
template<typename _Environment >
|
pure virtual |
- Returns
- a textual description of this convergence criterion.
Implemented in GQCP::CompoundConvergenceCriterion< _Environment >, GQCP::ConsecutiveIteratesNormConvergence< _Iterate, _Environment >, and GQCP::ResidualVectorConvergence< _Environment >.
◆ isFulfilled()
template<typename _Environment >
|
pure virtual |
- Parameters
-
environment the environment that this criterion can read from
- Returns
- if this criterion is fulfilled
Implemented in GQCP::CompoundConvergenceCriterion< _Environment >, GQCP::ConsecutiveIteratesNormConvergence< _Iterate, _Environment >, and GQCP::ResidualVectorConvergence< _Environment >.
The documentation for this class was generated from the following file:
- /__w/GQCP/GQCP/gqcp/include/Mathematical/Algorithm/ConvergenceCriterion.hpp
