RMOL Logo  1.00.10
C++ library of Revenue Management and Optimisation classes and functions
Loading...
Searching...
No Matches
RMOL::OptimizationType Struct Reference

#include <rmol/OptimizationType.hpp>

+ Inheritance diagram for RMOL::OptimizationType:

Public Types

enum  EN_OptimizationType {
  OPT_MC = 0 , OPT_DP , HEUR_EMSR , HEUR_EMSRA ,
  HEUR_EMSRB , HEUR_MC_4_QFF , HEUR_EMSRB_4_QFF , HEUR_MRT_QFF ,
  LAST_VALUE
}
 

Public Member Functions

EN_OptimizationType getType () const
 
std::string getTypeAsString () const
 
const std::string describe () const
 
bool operator== (const EN_OptimizationType &) const
 
 OptimizationType (const EN_OptimizationType &)
 
 OptimizationType (const char iType)
 
 OptimizationType (const std::string &iTypeStr)
 
 OptimizationType (const OptimizationType &)
 

Static Public Member Functions

static const std::string & getLabel (const EN_OptimizationType &)
 
static char getTypeLabel (const EN_OptimizationType &)
 
static std::string getTypeLabelAsString (const EN_OptimizationType &)
 
static std::string describeLabels ()
 

Detailed Description

Enumeration of optimization types.

Definition at line 17 of file OptimizationType.hpp.

Member Enumeration Documentation

◆ EN_OptimizationType

Enumerator
OPT_MC 
OPT_DP 
HEUR_EMSR 
HEUR_EMSRA 
HEUR_EMSRB 
HEUR_MC_4_QFF 
HEUR_EMSRB_4_QFF 
HEUR_MRT_QFF 
LAST_VALUE 

Definition at line 19 of file OptimizationType.hpp.

Constructor & Destructor Documentation

◆ OptimizationType() [1/4]

RMOL::OptimizationType::OptimizationType ( const EN_OptimizationType & iOptimizationType)

Constructor.

Definition at line 42 of file OptimizationType.cpp.

◆ OptimizationType() [2/4]

RMOL::OptimizationType::OptimizationType ( const char iType)

Constructor using a char.

Definition at line 48 of file OptimizationType.cpp.

References describeLabels(), HEUR_EMSR, HEUR_EMSRA, HEUR_EMSRB, HEUR_EMSRB_4_QFF, HEUR_MC_4_QFF, HEUR_MRT_QFF, LAST_VALUE, OPT_DP, and OPT_MC.

◆ OptimizationType() [3/4]

RMOL::OptimizationType::OptimizationType ( const std::string & iTypeStr)

Constructor using a string.

Definition at line 71 of file OptimizationType.cpp.

References describeLabels(), and LAST_VALUE.

◆ OptimizationType() [4/4]

RMOL::OptimizationType::OptimizationType ( const OptimizationType & iOptimizationType)

Default copy constructor.

Definition at line 37 of file OptimizationType.cpp.

Member Function Documentation

◆ getLabel()

const std::string & RMOL::OptimizationType::getLabel ( const EN_OptimizationType & iType)
static

Get the label as a string (e.g., "OptimalByMC", "OptimalByDP", "HeuristicByEMSR", "HeuristicByEMSRa", "HeuristicByEMSRb", "HeuristicByMCForQFF", "HeuristicByEMSRbForQFF" or "HeuristicByMRTForQFF").

Definition at line 90 of file OptimizationType.cpp.

◆ getTypeLabel()

char RMOL::OptimizationType::getTypeLabel ( const EN_OptimizationType & iType)
static

Get the label as a single char (e.g., 'M', 'D', 'E', 'A', 'B', 'Q', 'C' or 'R').

Definition at line 96 of file OptimizationType.cpp.

◆ getTypeLabelAsString()

std::string RMOL::OptimizationType::getTypeLabelAsString ( const EN_OptimizationType & iType)
static

Get the label as a string of a single char (e.g., "M", "D", "E", "A", "B", "Q", "C" or "R").

Definition at line 101 of file OptimizationType.cpp.

◆ describeLabels()

std::string RMOL::OptimizationType::describeLabels ( )
static

List the labels.

Definition at line 109 of file OptimizationType.cpp.

References LAST_VALUE.

Referenced by OptimizationType(), and OptimizationType().

◆ getType()

OptimizationType::EN_OptimizationType RMOL::OptimizationType::getType ( ) const

Get the enumerated value.

Definition at line 121 of file OptimizationType.cpp.

◆ getTypeAsString()

std::string RMOL::OptimizationType::getTypeAsString ( ) const

Get the enumerated value as a short string (e.g., "M", "D", "E", "A", "B", "Q", "C" or "R").

Definition at line 126 of file OptimizationType.cpp.

◆ describe()

const std::string RMOL::OptimizationType::describe ( ) const

Get a description of the structure (e.g., "OptimalByMC", "OptimalByDP", "HeuristicByEMSR", "HeuristicByEMSRa", "HeuristicByEMSRb", "HeuristicByMCForQFF", "HeuristicByEMSRbForQFF" or "HeuristicByMRTForQFF").

Definition at line 133 of file OptimizationType.cpp.

◆ operator==()

bool RMOL::OptimizationType::operator== ( const EN_OptimizationType & iType) const

Comparison operator.

Definition at line 140 of file OptimizationType.cpp.


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