rmol.cpp

Go to the documentation of this file.

// STL
#include <cassert>
#include <iostream>
#include <sstream>
#include <fstream>
#include <string>
// Boost (Extended STL)
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/date_time/gregorian/gregorian.hpp>
#include <boost/program_options.hpp>
// StdAir
#include <stdair/service/Logger.hpp>
// RMOL
#include <rmol/basic/BasConst_General.hpp>
#include <rmol/RMOL_Service.hpp>
#include <rmol/config/rmol-paths.hpp>

// //////// Constants //////
const std::string K_RMOL_DEFAULT_LOG_FILENAME ("rmol.log");

const bool K_RMOL_DEFAULT_BUILT_IN_INPUT = false;

const std::string K_RMOL_DEFAULT_INPUT_FILENAME (STDAIR_SAMPLE_DIR "/rm01.csv");

const int K_RMOL_DEFAULT_RANDOM_DRAWS = RMOL::DEFAULT_NUMBER_OF_DRAWS_FOR_MC_SIMULATION;

const double K_RMOL_DEFAULT_CAPACITY = 500.0;

const short K_RMOL_DEFAULT_METHOD = 0;

// ///////// Parsing of Options & Configuration /////////
// A helper function to simplify the main part.
template<class T> std::ostream& operator<< (std::ostream& os,
                                            const std::vector<T>& v) {
  std::copy (v.begin(), v.end(), std::ostream_iterator<T> (std::cout, " ")); 
  return os;
}

const int K_RMOL_EARLY_RETURN_STATUS = 99;

int readConfiguration(int argc, char* argv[], 
                      int& ioRandomDraws, double& ioCapacity, 
                      short& ioMethod, bool& ioIsBuiltin,
                      std::string& ioInputFilename, std::string& ioLogFilename){

  // Default for the built-in input
  ioIsBuiltin = K_RMOL_DEFAULT_BUILT_IN_INPUT;
    
  // Declare a group of options that will be allowed only on command line
  boost::program_options::options_description generic ("Generic options");
  generic.add_options()
    ("prefix", "print installation prefix")
    ("version,v", "print version string")
    ("help,h", "produce help message");
    
  // Declare a group of options that will be allowed both on command
  // line and in config file
  boost::program_options::options_description config ("Configuration");
  config.add_options()
    ("draws,d",
     boost::program_options::value<int>(&ioRandomDraws)->default_value(K_RMOL_DEFAULT_RANDOM_DRAWS), 
     "Number of to-be-generated random draws")
    ("capacity,c",
     boost::program_options::value<double>(&ioCapacity)->default_value(K_RMOL_DEFAULT_CAPACITY), 
     "Resource capacity (e.g., for a flight leg)")
    ("method,m",
     boost::program_options::value<short>(&ioMethod)->default_value(K_RMOL_DEFAULT_METHOD), 
     "Revenue Management method to be used (0 = Monte-Carlo, 1 = Dynamic Programming, 2 = EMSR, 3 = EMSR-a, 4 = EMSR-b)")
    ("builtin,b",
     "The cabin set up can be either built-in or parsed from an input file. That latter must then be given with the -i/--input option")
    ("input,i",
     boost::program_options::value< std::string >(&ioInputFilename)->default_value(K_RMOL_DEFAULT_INPUT_FILENAME),
     "(CSV) input file for the demand distribution parameters and resource (leg-cabin) capacities")
    ("log,l",
     boost::program_options::value< std::string >(&ioLogFilename)->default_value(K_RMOL_DEFAULT_LOG_FILENAME),
     "Filename for the logs")
    ;

  // Hidden options, will be allowed both on command line and
  // in config file, but will not be shown to the user.
  boost::program_options::options_description hidden ("Hidden options");
  hidden.add_options()
    ("copyright",
     boost::program_options::value< std::vector<std::string> >(),
     "Show the copyright (license)");
        
  boost::program_options::options_description cmdline_options;
  cmdline_options.add(generic).add(config).add(hidden);

  boost::program_options::options_description config_file_options;
  config_file_options.add(config).add(hidden);

  boost::program_options::options_description visible ("Allowed options");
  visible.add(generic).add(config);
        
  boost::program_options::positional_options_description p;
  p.add ("copyright", -1);
        
  boost::program_options::variables_map vm;
  boost::program_options::
    store (boost::program_options::command_line_parser (argc, argv).
           options (cmdline_options).positional(p).run(), vm);

  std::ifstream ifs ("rmol.cfg");
  boost::program_options::store (parse_config_file (ifs, config_file_options),
                                 vm);
  boost::program_options::notify (vm);
    
  if (vm.count ("help")) {
    std::cout << visible << std::endl;
    return K_RMOL_EARLY_RETURN_STATUS;
  }

  if (vm.count ("version")) {
    std::cout << PACKAGE_NAME << ", version " << PACKAGE_VERSION << std::endl;
    return K_RMOL_EARLY_RETURN_STATUS;
  }

  if (vm.count ("prefix")) {
    std::cout << "Installation prefix: " << PREFIXDIR << std::endl;
    return K_RMOL_EARLY_RETURN_STATUS;
  }

  if (vm.count ("builtin")) {
    ioIsBuiltin = true;
  }
  const std::string isBuiltinStr = (ioIsBuiltin == true)?"yes":"no";
  std::cout << "The BOM should be built-in? " << isBuiltinStr << std::endl;

  if (ioIsBuiltin == false) {
    if (vm.count ("input")) {
      ioInputFilename = vm["input"].as< std::string >();
      std::cout << "Input filename is: " << ioInputFilename << std::endl;
    }
  }

  if (vm.count ("log")) {
    ioLogFilename = vm["log"].as< std::string >();
    std::cout << "Log filename is: " << ioLogFilename << std::endl;
  }

  std::cout << "The number of random draws is: " << ioRandomDraws << std::endl;
  std::cout << "The resource capacity is: " << ioCapacity << std::endl;
  std::cout << "The optimisation method is: " << ioMethod << std::endl;
  std::cout << std::endl;
  
  return 0;
}

// /////////////////////////////////////////////////////
void optimise (RMOL::RMOL_Service& rmolService,
               const short& iMethod, const int& iRandomDraws) {

  switch (iMethod) {
  case 0: {
    // Calculate the optimal protections by the Monte Carlo
    // Integration approach
    rmolService.optimalOptimisationByMCIntegration (iRandomDraws);
    break;
  }
  case 1: {
    // Calculate the optimal protections by DP.
    rmolService.optimalOptimisationByDP ();
    break;
  }
  case 2: {
    // Calculate the Bid-Price Vector by EMSR
    rmolService.heuristicOptimisationByEmsr ();
    break;
  }
  case 3: {
    // Calculate the protections by EMSR-a
    rmolService.heuristicOptimisationByEmsrA ();
    break;
  }
  case 4: {
    // Calculate the protections by EMSR-b
    rmolService.heuristicOptimisationByEmsrB ();
    break;
  }
  default: {
    rmolService.optimalOptimisationByMCIntegration (iRandomDraws);
  }
  }
}

// ///////// M A I N ////////////
int main (int argc, char* argv[]) {

  // Number of random draws to be generated (best if greater than 100)
  int lRandomDraws = 0;
    
  // Cabin Capacity (it must be greater then 100 here)
  double lCapacity = 0.0;

  // Methods of optimisation (0 = Monte-Carlo, 1 = Dynamic Programming, 
  // 2 = EMSR, 3 = EMSR-a, 4 = EMSR-b)
  short lMethod = 0;   
    
  // Built-in
  bool isBuiltin;
    
  // Input file name
  std::string lInputFilename;

  // Output log File
  std::string lLogFilename;

  // Call the command-line option parser
  const int lOptionParserStatus = 
    readConfiguration (argc, argv, lRandomDraws, lCapacity, lMethod,
                       isBuiltin, lInputFilename, lLogFilename);

  if (lOptionParserStatus == K_RMOL_EARLY_RETURN_STATUS) {
    return 0;
  }

  // Set the log parameters
  std::ofstream logOutputFile;
  // Open and clean the log outputfile
  logOutputFile.open (lLogFilename.c_str());
  logOutputFile.clear();

  // Initialise the log stream
  const stdair::BasLogParams lLogParams (stdair::LOG::DEBUG, logOutputFile);

  // Initialise the RMOL service
  RMOL::RMOL_Service rmolService (lLogParams);

  if (isBuiltin == true) {
    // DEBUG
    STDAIR_LOG_DEBUG ("No input file has been given."
                      "A sample BOM tree will therefore be built.");

    // Build a sample BOM tree
    rmolService.buildSampleBom();

  } else {
    // DEBUG
    STDAIR_LOG_DEBUG ("RMOL will parse " << lInputFilename
                      << " and build the corresponding BOM tree.");

    //
    rmolService.parseAndLoad (lCapacity, lInputFilename);
  }

  // Launch the optimisation
  optimise (rmolService, lMethod, lRandomDraws);

  //
  logOutputFile.close();

  return 0;     
}