MAiNGO
maingo::MAiNGOmodelEpsCon Class Referenceabstract

This class is the base class for implementing bi-objective problems. More...

#include <MAiNGOmodelEpsCon.h>

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

Public Member Functions

virtual ~MAiNGOmodelEpsCon ()
 Destructor. More...
 
virtual EvaluationContainer evaluate_user_model (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...
 
EvaluationContainer evaluate (const std::vector< Var > &optVars) final
 Virtual function which has to be implemented by the user in order to enable evaluation of the model. 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...
 
void set_epsilon (const std::vector< double > &epsilon)
 Function for changing the epsilon-parameters. More...
 
void set_objective_index (const size_t objectiveIndex)
 Function for setting the objective index. More...
 
void set_single_objective (bool singleObjective)
 Function for setting the _singleObjective flag. More...
 
- Public Member Functions inherited from maingo::MAiNGOmodel
virtual ~MAiNGOmodel ()
 Destructor. More...
 

Private Attributes

std::vector< double > _epsilon
 
size_t _objectiveIndex
 
bool _singleObjective = true
 

Additional Inherited Members

- Public Types inherited from maingo::MAiNGOmodel
using Var = mc::FFVar
 

Detailed Description

This class is the base class for implementing bi-objective problems.

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

Constructor & Destructor Documentation

◆ ~MAiNGOmodelEpsCon()

virtual maingo::MAiNGOmodelEpsCon::~MAiNGOmodelEpsCon ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ evaluate()

EvaluationContainer maingo::MAiNGOmodelEpsCon::evaluate ( const std::vector< Var > &  optVars)
finalvirtual

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

Implements maingo::MAiNGOmodel.

◆ evaluate_user_model()

virtual EvaluationContainer maingo::MAiNGOmodelEpsCon::evaluate_user_model ( 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

◆ get_initial_point()

virtual std::vector<double> maingo::MAiNGOmodelEpsCon::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 from maingo::MAiNGOmodel.

◆ get_variables()

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

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

Implements maingo::MAiNGOmodel.

◆ set_epsilon()

void maingo::MAiNGOmodelEpsCon::set_epsilon ( const std::vector< double > &  epsilon)
inline

Function for changing the epsilon-parameters.

Parameters
[in]epsilonis a vector holding the epsilon parameters

◆ set_objective_index()

void maingo::MAiNGOmodelEpsCon::set_objective_index ( const size_t  objectiveIndex)
inline

Function for setting the objective index.

Parameters
[in]objectiveIndexis the index of the objective to be minimized

◆ set_single_objective()

void maingo::MAiNGOmodelEpsCon::set_single_objective ( bool  singleObjective)
inline

Function for setting the _singleObjective flag.

Parameters
[in]singleObjectiveindicates whether the next problem should be considered as single-objective

Member Data Documentation

◆ _epsilon

std::vector<double> maingo::MAiNGOmodelEpsCon::_epsilon
private

vector of epsilon parameters for use in the epsilon-constraint method

◆ _objectiveIndex

size_t maingo::MAiNGOmodelEpsCon::_objectiveIndex
private

index of objective to be minimized during epsilon-constraint method. The other objective will be used in the epsilon-constraint

◆ _singleObjective

bool maingo::MAiNGOmodelEpsCon::_singleObjective = true
private

flag indicating whether the next problem should be considered as single-objective (for objective _objectiveIndex), or whether to use the epsilon constraint(s)


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