GQCP::CompoundConvergenceCriterion< _Environment > Class Template Reference

#include <CompoundConvergenceCriterion.hpp>

Inheritance diagram for GQCP::CompoundConvergenceCriterion< _Environment >:

Collaboration diagram for GQCP::CompoundConvergenceCriterion< _Environment >:

Public Types
using	Environment = _Environment
using	Self = CompoundConvergenceCriterion< Environment >
Public Types inherited from GQCP::ConvergenceCriterion< _Environment >
using	Environment = _Environment

Public Member Functions
template<typename C1 , typename C2 >
	CompoundConvergenceCriterion (const C1 &criterion1, const C2 &criterion2)
std::string	description () const override
bool	isFulfilled (Environment &environment) override
template<typename C >
Self	add (const C &criterion)
size_t	count () const
Public Member Functions inherited from GQCP::ConvergenceCriterion< _Environment >
virtual	~ConvergenceCriterion ()=default
virtual std::string	description () const =0
virtual bool	isFulfilled (Environment &environment)=0

Detailed Description

template<typename _Environment>
class GQCP::CompoundConvergenceCriterion< _Environment >

A criterion that checks convergence by requiring that multiple convergence criteria are fulfilled simultaneously.

Parameters

_Environment

the type of the environment that this criterion can read from

Member Typedef Documentation

Environment

template<typename _Environment >

using GQCP::CompoundConvergenceCriterion< _Environment >::Environment = _Environment

Self

template<typename _Environment >

using GQCP::CompoundConvergenceCriterion< _Environment >::Self = CompoundConvergenceCriterion<Environment>

Constructor & Destructor Documentation

CompoundConvergenceCriterion()

template<typename _Environment >

template<typename C1 , typename C2 >

GQCP::CompoundConvergenceCriterion< _Environment >::CompoundConvergenceCriterion ( const C1 &  criterion1, const C2 &  criterion2  )

inline

A basic constructor from two criteria that should be fulfilled at the same time.

Parameters

criterion1	the first convergence criterion
criterion2	the second convergence criterion

Member Function Documentation

add()

template<typename _Environment >

template<typename C >

Self GQCP::CompoundConvergenceCriterion< _Environment >::add ( const C &  criterion )

inline

Add another convergence criterion that should be fulfilled in this compound convergence criterion.

Parameters

criterion

the new convergence criterion

Returns

an updated version of *this, in order to allow chaining

count()

template<typename _Environment >

size_t GQCP::CompoundConvergenceCriterion< _Environment >::count ( ) const

inline

Returns

the number of simple convergence criteria that are compounded in this one

description()

template<typename _Environment >

std::string GQCP::CompoundConvergenceCriterion< _Environment >::description ( ) const

inlineoverridevirtual

PUBLIC OVERRIDDEN METHODS

Returns

a textual description of this algorithmic step

Implements GQCP::ConvergenceCriterion< _Environment >.

isFulfilled()

template<typename _Environment >

bool GQCP::CompoundConvergenceCriterion< _Environment >::isFulfilled ( Environment &  environment )

inlineoverridevirtual

Parameters

environment

the environment that this criterion can read from

Returns

if this criterion is fulfilled

Implements GQCP::ConvergenceCriterion< _Environment >.

---

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

• /__w/GQCP/GQCP/gqcp/include/Mathematical/Algorithm/CompoundConvergenceCriterion.hpp