GQCP::FunctionalStep< _Environment > Class Template Reference

#include <FunctionalStep.hpp>

Inheritance diagram for GQCP::FunctionalStep< _Environment >:

Collaboration diagram for GQCP::FunctionalStep< _Environment >:

Public Types
using	Environment = _Environment
using	Function = std::function< void(Environment &)>
Public Types inherited from GQCP::Step< _Environment >
using	Environment = _Environment

Public Member Functions
	FunctionalStep (const Function &function, const std::string &description="A custom functional step.")
std::string	description () const override
void	execute (Environment &environment) override
Public Member Functions inherited from GQCP::Step< _Environment >
virtual	~Step ()=default
virtual std::string	description () const =0
virtual void	execute (Environment &environment)=0

Detailed Description

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

A general algorithmic step that acts as a wrapper around a function call.

Parameters

_Environment

the type of the environment that this step can read from and write to

Member Typedef Documentation

Environment

template<typename _Environment >

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

Function

template<typename _Environment >

using GQCP::FunctionalStep< _Environment >::Function = std::function<void(Environment&)>

Constructor & Destructor Documentation

FunctionalStep()

template<typename _Environment >

GQCP::FunctionalStep< _Environment >::FunctionalStep ( const Function &  function, const std::string &  description = "A custom functional step."  )

inline

Create a Step by wrapping a function.

Parameters

function

the function that this Step wraps

Member Function Documentation

description()

template<typename _Environment >

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

inlineoverridevirtual

Returns

a textual description of this algorithmic step

Implements GQCP::Step< _Environment >.

execute()

template<typename _Environment >

void GQCP::FunctionalStep< _Environment >::execute ( Environment &  environment )

inlineoverridevirtual

Execute/perform this algorithm step.

Parameters

environment

the environment that this step can read from and write to

Implements GQCP::Step< _Environment >.

---

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

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