GQCP::Algorithm< _Environment > Class Template Reference

#include <Algorithm.hpp>

Collaboration diagram for GQCP::Algorithm< _Environment >:

Public Types
using	Environment = _Environment

Public Member Functions
	Algorithm (const StepCollection< Environment > &steps)
std::string	description () const
void	perform (Environment &environment)

Detailed Description

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

An algorithm that only performs one collection of steps.

Parameters

_Environment

the type of environment that this algorithm is associated to

Member Typedef Documentation

Environment

template<typename _Environment >

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

Constructor & Destructor Documentation

Algorithm()

template<typename _Environment >

GQCP::Algorithm< _Environment >::Algorithm ( const StepCollection< Environment > &  steps )

inline

Parameters

steps

the steps that should be executed when this algorithm is performed

Member Function Documentation

description()

template<typename _Environment >

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

inline

Returns

a textual description of this iterative algorithm.

perform()

template<typename _Environment >

void GQCP::Algorithm< _Environment >::perform ( Environment &  environment )

inline

Parameters

environment

the environment that this algorithm is associated to

---

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

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