MAiNGO
maingo::AleModel Class Reference

This class provides the interface for a program composed of ALE expressions. More...

#include <aleModel.h>

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

Public Member Functions

EvaluationContainer evaluate (const std::vector< Var > &optVars)
 Main function used to evaluate the model and construct a directed acyclic graph. More...
 
 AleModel (Program prog, ale::symbol_table &symbols)
 Constructor taking a ALE-based Program and an ALE symbol_table. More...
 
std::vector< OptimizationVariableget_variables ()
 Function for getting optimization variables data. More...
 
const std::unordered_map< std::string, int > & get_positions ()
 Function for getting optimization variable position data. More...
 
std::vector< double > get_initial_point ()
 Function for getting initial point data. More...
 
void make_variables ()
 Function for populating _variables, _initials, and _positions. More...
 
- Public Member Functions inherited from maingo::MAiNGOmodel
virtual ~MAiNGOmodel ()
 Destructor. More...
 

Private Attributes

Program _prog
 
ale::symbol_table & _symbols
 
std::vector< OptimizationVariable_variables
 
std::vector< double > _initials
 
std::unordered_map< std::string, int > _positions
 

Additional Inherited Members

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

Detailed Description

This class provides the interface for a program composed of ALE expressions.

Constructor & Destructor Documentation

◆ AleModel()

maingo::AleModel::AleModel ( Program  prog,
ale::symbol_table &  symbols 
)
inline

Constructor taking a ALE-based Program and an ALE symbol_table.

Parameters
[in]progis the program to translate to MAiNGO
[in]symbolsis the symbol_table used to resolve symbols used in prog

Member Function Documentation

◆ evaluate()

EvaluationContainer AleModel::evaluate ( const std::vector< Var > &  optVars)
virtual

Main function used to evaluate the model and construct a directed acyclic graph.

Parameters
[in]optVarsis the optimization variables vector

Implements maingo::MAiNGOmodel.

◆ get_initial_point()

std::vector< double > AleModel::get_initial_point ( )
virtual

Function for getting initial point data.

Reimplemented from maingo::MAiNGOmodel.

◆ get_positions()

const std::unordered_map< std::string, int > & AleModel::get_positions ( )

Function for getting optimization variable position data.

◆ get_variables()

std::vector< OptimizationVariable > AleModel::get_variables ( )
virtual

Function for getting optimization variables data.

Implements maingo::MAiNGOmodel.

◆ make_variables()

void AleModel::make_variables ( )

Function for populating _variables, _initials, and _positions.

Member Data Documentation

◆ _initials

std::vector<double> maingo::AleModel::_initials
private

Initial point for _variables

◆ _positions

std::unordered_map<std::string, int> maingo::AleModel::_positions
private

Association of ALE symbol names to positions in _variables

◆ _prog

Program maingo::AleModel::_prog
private

Container for ALE expressions

◆ _symbols

ale::symbol_table& maingo::AleModel::_symbols
private

Container for ALE symbols

◆ _variables

std::vector<OptimizationVariable> maingo::AleModel::_variables
private

OptimiztionVariables used in the model


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