MAiNGO
maingo::OutputVariable Struct Reference

Struct for storing additional output variables. More...

#include <outputVariable.h>

Public Member Functions

 OutputVariable (const std::string descIn, const mc::FFVar valueIn)
 Constructor for use in the evaluate function. More...
 
 OutputVariable (const mc::FFVar valueIn, const std::string descIn)
 Constructor for use in the evaluate function. More...
 
 OutputVariable (const OutputVariable &variableIn)
 Copy constructor. More...
 
OutputVariableoperator= (const OutputVariable &variableIn)
 Copy assignment operator. More...
 

Public Attributes

std::string description
 
mc::FFVar value
 

Detailed Description

Struct for storing additional output variables.

Since the model evaluation can contain several intermediate variables that appear neither as optimization variables nor as constraints directly, but the value of which might be interesting at the optimal solution point, a vector of these structs can be used in the EvaluationContainer to give such additional output after the problem is solved.

Constructor & Destructor Documentation

◆ OutputVariable() [1/3]

maingo::OutputVariable::OutputVariable ( const std::string  descIn,
const mc::FFVar  valueIn 
)
inline

Constructor for use in the evaluate function.

Parameters
[in]descInis a string describing the variable
[in]valueInis the value of the variable at the current point

◆ OutputVariable() [2/3]

maingo::OutputVariable::OutputVariable ( const mc::FFVar  valueIn,
const std::string  descIn 
)
inline

Constructor for use in the evaluate function.

Parameters
[in]valueInis the value of the variable at the current point
[in]descInis a string describing the variable

◆ OutputVariable() [3/3]

maingo::OutputVariable::OutputVariable ( const OutputVariable variableIn)
inline

Copy constructor.

Parameters
[in]variableInis the output variable to be copied

Member Function Documentation

◆ operator=()

OutputVariable& maingo::OutputVariable::operator= ( const OutputVariable variableIn)
inline

Copy assignment operator.

Parameters
[in]variableInis the output variable to be copied

Member Data Documentation

◆ description

std::string maingo::OutputVariable::description

Description, e.g. name of variable

◆ value

mc::FFVar maingo::OutputVariable::value

Variable object


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