MAiNGO
maingo::MAiNGOmodel Class Referenceabstract

This class is the base class for models to be solved by MAiNGO. More...

#include <MAiNGOmodel.h>

Inheritance diagram for maingo::MAiNGOmodel:
maingo::AleModel maingo::MAiNGOmodelEpsCon

Public Types

using Var = mc::FFVar
 

Public Member Functions

virtual ~MAiNGOmodel ()
 Destructor. More...
 
virtual EvaluationContainer evaluate (const std::vector< Var > &optVars)=0
 Virtual function which has to be implemented by the user in order to enable evaluation of the model. More...
 
virtual std::vector< OptimizationVariableget_variables ()=0
 Virtual function which has to be implemented by the user in order to enable getting data on optimization variables. More...
 
virtual std::vector< double > get_initial_point ()
 Virtual function which has to be implemented by the user in order to enable getting data on the initial point. More...
 

Detailed Description

This class is the base class for models to be solved by MAiNGO.

This class is used to derive a Model class in problem.h, where the user can implement their actual model.

Member Typedef Documentation

◆ Var

using maingo::MAiNGOmodel::Var = mc::FFVar

Redefine for easier usage

Constructor & Destructor Documentation

◆ ~MAiNGOmodel()

virtual maingo::MAiNGOmodel::~MAiNGOmodel ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ evaluate()

virtual EvaluationContainer maingo::MAiNGOmodel::evaluate ( const std::vector< Var > &  optVars)
pure virtual

Virtual function which has to be implemented by the user in order to enable evaluation of the model.

Parameters
[in]optVarsis a vector holding the optimization variables

Implemented in maingo::MAiNGOmodelEpsCon, and maingo::AleModel.

◆ get_initial_point()

virtual std::vector<double> maingo::MAiNGOmodel::get_initial_point ( )
inlinevirtual

Virtual function which has to be implemented by the user in order to enable getting data on the initial point.

Reimplemented in maingo::AleModel, and maingo::MAiNGOmodelEpsCon.

◆ get_variables()

virtual std::vector<OptimizationVariable> maingo::MAiNGOmodel::get_variables ( )
pure virtual

Virtual function which has to be implemented by the user in order to enable getting data on optimization variables.

Implemented in maingo::AleModel, and maingo::MAiNGOmodelEpsCon.


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