CbcGenParam.hpp

Go to the documentation of this file.

/*
  Copyright (C) 2007, Lou Hafer, International Business Machines Corporation
  and others.  All Rights Reserved.

  This file is part of cbc-generic.
*/

#ifndef CbcGenParam_H
#define CbcGenParam_H

/* \file CbcGenParam.hpp
   \brief Declarations for parameters that control the cbc-generic main
          program.
*/

/*
  $Id: CbcGenParam.hpp 1173 2009-06-04 09:44:10Z forrest $
*/

class CbcGenCtlBlk ;

class CbcGenParam : public CoinParam {

public:


    typedef enum { CBCGEN_FIRSTPARAM = 0,

                   GENERALQUERY, FULLGENERALQUERY, HELP,
                   BAB, CLEARCUTS, CLIQUECUTS, COMBINE, COSTSTRATEGY,
                   CPP, CUTDEPTH, CUTSTRATEGY,
                   DEBUG, DIRECTORY, DJFIX, DUMMY,
                   ERRORSALLOWED, EXIT, EXPORT,
                   FLOWCUTS, FPUMP, FPUMPITS, GOMORYCUTS, GREEDY, HEURISTICSTRATEGY,
                   IMPORT, INTPRINT, KNAPSACKCUTS, LOCALTREE, LOGLEVEL,
                   MESSAGES, MIPLIB, MIXEDCUTS, ODDHOLECUTS, OUTDUPROWS, OUTPUTFORMAT,
                   PREPROCESS, PRINTMASK, PRINTOPTIONS, PRINTVERSION, PRIORITYIN, PROBINGCUTS,
                   REDSPLITCUTS, ROUNDING,
                   SOLUTION, SOLVECONTINUOUS, SOLVER, SOS, STDIN, STRENGTHEN,
                   TIGHTENFACTOR, TWOMIRCUTS,
                   UNITTEST, USERCBC, USESOLUTION, VERBOSE, SHOWUNIMP,

                   CBCGEN_LASTPARAM

                 } CbcGenParamCode ;


    CbcGenParam() ;

    CbcGenParam(CbcGenParamCode code, std::string name, std::string help,
                double lower, double upper, double dflt = 0.0,
                bool display = true) ;

    CbcGenParam(CbcGenParamCode code, std::string name, std::string help,
                int lower, int upper, int dflt = 0,
                bool display = true) ;

    CbcGenParam(CbcGenParamCode code, std::string name, std::string help,
                std::string firstValue, int dflt, bool display = true) ;

    CbcGenParam(CbcGenParamCode code, std::string name, std::string help,
                std::string dflt, bool display = true) ;

    CbcGenParam(CbcGenParamCode code, std::string name, std::string help,
                bool display = true) ;

    CbcGenParam(const CbcGenParam &orig) ;

    CbcGenParam *clone() ;

    CbcGenParam &operator=(const CbcGenParam &rhs) ;

    ~CbcGenParam() ;



    inline CbcGenParamCode paramCode() const {
        return (paramCode_) ;
    }

    inline void setParamCode(CbcGenParamCode code) {
        paramCode_ = code ;
    }

    inline CbcGenCtlBlk *obj() const {
        return (obj_) ;
    }

    inline void setObj(CbcGenCtlBlk *obj) {
        obj_ = obj ;
    }



private:


    CbcGenParamCode paramCode_ ;

    CbcGenCtlBlk *obj_ ;


} ;

/*
  Declare the utility functions.
*/

namespace CbcGenParamUtils {
void addCbcGenParams(int &numParams, CoinParamVec &paramVec,
                     CbcGenCtlBlk *ctlBlk) ;
void loadGenParamObj(const CoinParamVec paramVec, int first, int last,
                     CbcGenCtlBlk *ctlBlk) ;

void saveSolution(const OsiSolverInterface *osi, std::string fileName) ;
bool readSolution(std::string fileName,
                  int &numRows, int &numCols, double &objVal,
                  double **rowActivity, double **dualVars,
                  double **primalVars, double **reducedCosts) ;

int doBaCParam(CoinParam *param) ;
int doDebugParam(CoinParam *param) ;
int doExitParam(CoinParam *param) ;
int doHelpParam(CoinParam *param) ;
int doImportParam(CoinParam *param) ;
int doPrintMaskParam(CoinParam *param) ;
int doNothingParam(CoinParam *param) ;
int doSolutionParam(CoinParam *param) ;
int doUnimplementedParam(CoinParam *param) ;
int doVersionParam(CoinParam *param) ;

int pushCbcGenDblParam(CoinParam *param) ;
int pushCbcGenIntParam(CoinParam *param) ;
int pushCbcGenKwdParam(CoinParam *param) ;
int pushCbcGenStrParam(CoinParam *param) ;

int pushCbcGenCutParam(CoinParam *param) ;
}


#endif