olb::opti::OptiCase< S, C > Class Template Reference

Abstract base class for optimization tasks. More...

#include <optiCase.h>

Inheritance diagram for olb::opti::OptiCase< S, C >:

Collaboration diagram for olb::opti::OptiCase< S, C >:

Public Member Functions
	OptiCase ()=default
	OptiCase (std::function< void(void)> postEvaluation)
virtual S	evaluateObjective (const C &control, unsigned optiStep=0)=0
virtual void	computeDerivatives (const C &control, C &derivatives, unsigned optiStep=0)=0
void	postEvaluation ()

Protected Attributes
std::function< void(void)>	_postEvaluation { [](){} }

Detailed Description

template<typename S, typename C>
class olb::opti::OptiCase< S, C >

Abstract base class for optimization tasks.

Definition at line 40 of file optiCase.h.

Constructor & Destructor Documentation

OptiCase() [1/2]

template<typename S , typename C >

olb::opti::OptiCase< S, C >::OptiCase ( )

default

OptiCase() [2/2]

template<typename S , typename C >

olb::opti::OptiCase< S, C >::OptiCase ( std::function< void(void)> postEvaluation )

inlineexplicit

Definition at line 48 of file optiCase.h.

   : _postEvaluation(postEvaluation)
  { }

Member Function Documentation

computeDerivatives()

template<typename S , typename C >

virtual void olb::opti::OptiCase< S, C >::computeDerivatives ( const C & control, C & derivatives, unsigned optiStep = 0 )

pure virtual

Implemented in olb::opti::OptiCaseAnalytical< S, C >, olb::opti::OptiCaseFDQ< S, C >, olb::opti::OptiCaseCDQ< S, C >, and olb::opti::OptiCaseDual< S, SOLVER, C >.

evaluateObjective()

template<typename S , typename C >

virtual S olb::opti::OptiCase< S, C >::evaluateObjective ( const C & control, unsigned optiStep = 0 )

pure virtual

Implemented in olb::opti::OptiCaseAnalytical< S, C >, olb::opti::OptiCaseDQ< S, C >, and olb::opti::OptiCaseDual< S, SOLVER, C >.

postEvaluation()

template<typename S , typename C >

void olb::opti::OptiCase< S, C >::postEvaluation ( )

inline

Definition at line 56 of file optiCase.h.

                        {
    _postEvaluation();
  }

References olb::opti::OptiCase< S, C >::_postEvaluation.

Member Data Documentation

_postEvaluation

template<typename S , typename C >

std::function<void (void)> olb::opti::OptiCase< S, C >::_postEvaluation { [](){} }

protected

Definition at line 43 of file optiCase.h.

{ [](){} };

---

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

• src/optimization/optiCase.h