Clp: src/CbcOrClpParam.hpp Source File

Go to the documentation of this file.
00001 
00002 /* $Id$ */
00003 // Copyright (C) 2002, International Business Machines
00004 // Corporation and others.  All Rights Reserved.
00005 // This code is licensed under the terms of the Eclipse Public License (EPL).
00006 
00007 #ifdef USE_CBCCONFIG
00008 # include "CbcConfig.h"
00009 #else
00010 # include "ClpConfig.h"
00011 #endif
00012 
00013 #ifndef CbcOrClpParam_H
00014 #define CbcOrClpParam_H
00015 
00027 class OsiSolverInterface;
00028 class CbcModel;
00029 class ClpSimplex;
00047 enum CbcOrClpParameterType
00048 
00049 {
00050      CBC_PARAM_GENERALQUERY = -100,
00051      CBC_PARAM_FULLGENERALQUERY,
00052 
00053      CLP_PARAM_DBL_PRIMALTOLERANCE = 1,
00054      CLP_PARAM_DBL_DUALTOLERANCE,
00055      CLP_PARAM_DBL_TIMELIMIT,
00056      CLP_PARAM_DBL_DUALBOUND,
00057      CLP_PARAM_DBL_PRIMALWEIGHT,
00058      CLP_PARAM_DBL_OBJSCALE,
00059      CLP_PARAM_DBL_RHSSCALE,
00060      CLP_PARAM_DBL_ZEROTOLERANCE,
00061 
00062      CBC_PARAM_DBL_INFEASIBILITYWEIGHT = 51,
00063      CBC_PARAM_DBL_CUTOFF,
00064      CBC_PARAM_DBL_INTEGERTOLERANCE,
00065      CBC_PARAM_DBL_INCREMENT,
00066      CBC_PARAM_DBL_ALLOWABLEGAP,
00067      CBC_PARAM_DBL_TIMELIMIT_BAB,
00068      CBC_PARAM_DBL_GAPRATIO,
00069 
00070      CBC_PARAM_DBL_DJFIX = 81,
00071      CBC_PARAM_DBL_TIGHTENFACTOR,
00072      CLP_PARAM_DBL_PRESOLVETOLERANCE,
00073      CLP_PARAM_DBL_OBJSCALE2,
00074      CBC_PARAM_DBL_FAKEINCREMENT,
00075      CBC_PARAM_DBL_FAKECUTOFF,
00076      CBC_PARAM_DBL_ARTIFICIALCOST,
00077      CBC_PARAM_DBL_DEXTRA3,
00078      CBC_PARAM_DBL_SMALLBAB,
00079      CBC_PARAM_DBL_DEXTRA4,
00080      CBC_PARAM_DBL_DEXTRA5,
00081 
00082      CLP_PARAM_INT_SOLVERLOGLEVEL = 101,
00083 #ifndef COIN_HAS_CBC
00084      CLP_PARAM_INT_LOGLEVEL = 101,
00085 #endif
00086      CLP_PARAM_INT_MAXFACTOR,
00087      CLP_PARAM_INT_PERTVALUE,
00088      CLP_PARAM_INT_MAXITERATION,
00089      CLP_PARAM_INT_PRESOLVEPASS,
00090      CLP_PARAM_INT_IDIOT,
00091      CLP_PARAM_INT_SPRINT,
00092      CLP_PARAM_INT_OUTPUTFORMAT,
00093      CLP_PARAM_INT_SLPVALUE,
00094      CLP_PARAM_INT_PRESOLVEOPTIONS,
00095      CLP_PARAM_INT_PRINTOPTIONS,
00096      CLP_PARAM_INT_SPECIALOPTIONS,
00097      CLP_PARAM_INT_SUBSTITUTION,
00098      CLP_PARAM_INT_DUALIZE,
00099      CLP_PARAM_INT_VERBOSE,
00100      CLP_PARAM_INT_CPP,
00101      CLP_PARAM_INT_PROCESSTUNE,
00102      CLP_PARAM_INT_USESOLUTION,
00103      CLP_PARAM_INT_RANDOMSEED,
00104      CLP_PARAM_INT_MORESPECIALOPTIONS,
00105 
00106      CBC_PARAM_INT_STRONGBRANCHING = 151,
00107      CBC_PARAM_INT_CUTDEPTH,
00108      CBC_PARAM_INT_MAXNODES,
00109      CBC_PARAM_INT_NUMBERBEFORE,
00110      CBC_PARAM_INT_NUMBERANALYZE,
00111      CBC_PARAM_INT_MIPOPTIONS,
00112      CBC_PARAM_INT_MOREMIPOPTIONS,
00113      CBC_PARAM_INT_MAXHOTITS,
00114      CBC_PARAM_INT_FPUMPITS,
00115      CBC_PARAM_INT_MAXSOLS,
00116      CBC_PARAM_INT_FPUMPTUNE,
00117      CBC_PARAM_INT_TESTOSI,
00118      CBC_PARAM_INT_EXTRA1,
00119      CBC_PARAM_INT_EXTRA2,
00120      CBC_PARAM_INT_EXTRA3,
00121      CBC_PARAM_INT_EXTRA4,
00122      CBC_PARAM_INT_DEPTHMINIBAB,
00123      CBC_PARAM_INT_CUTPASSINTREE,
00124      CBC_PARAM_INT_THREADS,
00125      CBC_PARAM_INT_CUTPASS,
00126      CBC_PARAM_INT_VUBTRY,
00127      CBC_PARAM_INT_DENSE,
00128      CBC_PARAM_INT_EXPERIMENT,
00129      CBC_PARAM_INT_DIVEOPT,
00130      CBC_PARAM_INT_STRATEGY,
00131      CBC_PARAM_INT_SMALLFACT,
00132      CBC_PARAM_INT_HOPTIONS,
00133      CBC_PARAM_INT_CUTLENGTH,
00134      CBC_PARAM_INT_FPUMPTUNE2,
00135 #ifdef COIN_HAS_CBC
00136      CLP_PARAM_INT_LOGLEVEL ,
00137 #endif
00138      CBC_PARAM_INT_MAXSAVEDSOLS,
00139      CBC_PARAM_INT_RANDOMSEED,
00140      CBC_PARAM_INT_MULTIPLEROOTS,
00141      CBC_PARAM_INT_STRONG_STRATEGY,
00142 
00143      CLP_PARAM_STR_DIRECTION = 201,
00144      CLP_PARAM_STR_DUALPIVOT,
00145      CLP_PARAM_STR_SCALING,
00146      CLP_PARAM_STR_ERRORSALLOWED,
00147      CLP_PARAM_STR_KEEPNAMES,
00148      CLP_PARAM_STR_SPARSEFACTOR,
00149      CLP_PARAM_STR_PRIMALPIVOT,
00150      CLP_PARAM_STR_PRESOLVE,
00151      CLP_PARAM_STR_CRASH,
00152      CLP_PARAM_STR_BIASLU,
00153      CLP_PARAM_STR_PERTURBATION,
00154      CLP_PARAM_STR_MESSAGES,
00155      CLP_PARAM_STR_AUTOSCALE,
00156      CLP_PARAM_STR_CHOLESKY,
00157      CLP_PARAM_STR_KKT,
00158      CLP_PARAM_STR_BARRIERSCALE,
00159      CLP_PARAM_STR_GAMMA,
00160      CLP_PARAM_STR_CROSSOVER,
00161      CLP_PARAM_STR_PFI,
00162      CLP_PARAM_STR_INTPRINT,
00163      CLP_PARAM_STR_VECTOR,
00164      CLP_PARAM_STR_FACTORIZATION,
00165      CLP_PARAM_STR_ALLCOMMANDS,
00166      CLP_PARAM_STR_TIME_MODE,
00167      CLP_PARAM_STR_ABCWANTED,
00168 
00169      CBC_PARAM_STR_NODESTRATEGY = 251,
00170      CBC_PARAM_STR_BRANCHSTRATEGY,
00171      CBC_PARAM_STR_CUTSSTRATEGY,
00172      CBC_PARAM_STR_HEURISTICSTRATEGY,
00173      CBC_PARAM_STR_GOMORYCUTS,
00174      CBC_PARAM_STR_PROBINGCUTS,
00175      CBC_PARAM_STR_KNAPSACKCUTS,
00176      CBC_PARAM_STR_REDSPLITCUTS,
00177      CBC_PARAM_STR_ROUNDING,
00178      CBC_PARAM_STR_SOLVER,
00179      CBC_PARAM_STR_CLIQUECUTS,
00180      CBC_PARAM_STR_COSTSTRATEGY,
00181      CBC_PARAM_STR_FLOWCUTS,
00182      CBC_PARAM_STR_MIXEDCUTS,
00183      CBC_PARAM_STR_TWOMIRCUTS,
00184      CBC_PARAM_STR_PREPROCESS,
00185      CBC_PARAM_STR_FPUMP,
00186      CBC_PARAM_STR_GREEDY,
00187      CBC_PARAM_STR_COMBINE,
00188      CBC_PARAM_STR_PROXIMITY,
00189      CBC_PARAM_STR_LOCALTREE,
00190      CBC_PARAM_STR_SOS,
00191      CBC_PARAM_STR_LANDPCUTS,
00192      CBC_PARAM_STR_RINS,
00193      CBC_PARAM_STR_RESIDCUTS,
00194      CBC_PARAM_STR_RENS,
00195      CBC_PARAM_STR_DIVINGS,
00196      CBC_PARAM_STR_DIVINGC,
00197      CBC_PARAM_STR_DIVINGF,
00198      CBC_PARAM_STR_DIVINGG,
00199      CBC_PARAM_STR_DIVINGL,
00200      CBC_PARAM_STR_DIVINGP,
00201      CBC_PARAM_STR_DIVINGV,
00202      CBC_PARAM_STR_DINS,
00203      CBC_PARAM_STR_PIVOTANDFIX,
00204      CBC_PARAM_STR_RANDROUND,
00205      CBC_PARAM_STR_NAIVE,
00206      CBC_PARAM_STR_ZEROHALFCUTS,
00207      CBC_PARAM_STR_CPX,
00208      CBC_PARAM_STR_CROSSOVER2,
00209      CBC_PARAM_STR_PIVOTANDCOMPLEMENT,
00210      CBC_PARAM_STR_VND,
00211      CBC_PARAM_STR_LAGOMORYCUTS,
00212 
00213      CLP_PARAM_ACTION_DIRECTORY = 301,
00214      CLP_PARAM_ACTION_DIRSAMPLE,
00215      CLP_PARAM_ACTION_DIRNETLIB,
00216      CBC_PARAM_ACTION_DIRMIPLIB,
00217      CLP_PARAM_ACTION_IMPORT,
00218      CLP_PARAM_ACTION_EXPORT,
00219      CLP_PARAM_ACTION_RESTORE,
00220      CLP_PARAM_ACTION_SAVE,
00221      CLP_PARAM_ACTION_DUALSIMPLEX,
00222      CLP_PARAM_ACTION_PRIMALSIMPLEX,
00223      CLP_PARAM_ACTION_EITHERSIMPLEX,
00224      CLP_PARAM_ACTION_MAXIMIZE,
00225      CLP_PARAM_ACTION_MINIMIZE,
00226      CLP_PARAM_ACTION_EXIT,
00227      CLP_PARAM_ACTION_STDIN,
00228      CLP_PARAM_ACTION_UNITTEST,
00229      CLP_PARAM_ACTION_NETLIB_EITHER,
00230      CLP_PARAM_ACTION_NETLIB_DUAL,
00231      CLP_PARAM_ACTION_NETLIB_PRIMAL,
00232      CLP_PARAM_ACTION_SOLUTION,
00233      CLP_PARAM_ACTION_SAVESOL,
00234      CLP_PARAM_ACTION_TIGHTEN,
00235      CLP_PARAM_ACTION_FAKEBOUND,
00236      CLP_PARAM_ACTION_HELP,
00237      CLP_PARAM_ACTION_PLUSMINUS,
00238      CLP_PARAM_ACTION_NETWORK,
00239      CLP_PARAM_ACTION_ALLSLACK,
00240      CLP_PARAM_ACTION_REVERSE,
00241      CLP_PARAM_ACTION_BARRIER,
00242      CLP_PARAM_ACTION_NETLIB_BARRIER,
00243      CLP_PARAM_ACTION_NETLIB_TUNE,
00244      CLP_PARAM_ACTION_REALLY_SCALE,
00245      CLP_PARAM_ACTION_BASISIN,
00246      CLP_PARAM_ACTION_BASISOUT,
00247      CLP_PARAM_ACTION_SOLVECONTINUOUS,
00248      CLP_PARAM_ACTION_CLEARCUTS,
00249      CLP_PARAM_ACTION_VERSION,
00250      CLP_PARAM_ACTION_STATISTICS,
00251      CLP_PARAM_ACTION_DEBUG,
00252      CLP_PARAM_ACTION_DUMMY,
00253      CLP_PARAM_ACTION_PRINTMASK,
00254      CLP_PARAM_ACTION_OUTDUPROWS,
00255      CLP_PARAM_ACTION_USERCLP,
00256      CLP_PARAM_ACTION_MODELIN,
00257      CLP_PARAM_ACTION_CSVSTATISTICS,
00258      CLP_PARAM_ACTION_STOREDFILE,
00259      CLP_PARAM_ACTION_ENVIRONMENT,
00260      CLP_PARAM_ACTION_PARAMETRICS,
00261      CLP_PARAM_ACTION_GMPL_SOLUTION,
00262 
00263      CBC_PARAM_ACTION_BAB = 351,
00264      CBC_PARAM_ACTION_MIPLIB,
00265      CBC_PARAM_ACTION_STRENGTHEN,
00266      CBC_PARAM_ACTION_PRIORITYIN,
00267      CBC_PARAM_ACTION_MIPSTART,
00268      CBC_PARAM_ACTION_USERCBC,
00269      CBC_PARAM_ACTION_DOHEURISTIC,
00270      CLP_PARAM_ACTION_NEXTBESTSOLUTION,
00271 
00272      CBC_PARAM_NOTUSED_OSLSTUFF = 401,
00273      CBC_PARAM_NOTUSED_CBCSTUFF,
00274 
00275      CBC_PARAM_NOTUSED_INVALID = 1000
00276 } ;
00277 #include <vector>
00278 #include <string>
00279 
00281 
00282 class CbcOrClpParam {
00283 public:
00286 
00287      CbcOrClpParam (  );
00288      CbcOrClpParam (std::string name, std::string help,
00289                     double lower, double upper, CbcOrClpParameterType type, int display = 2);
00290      CbcOrClpParam (std::string name, std::string help,
00291                     int lower, int upper, CbcOrClpParameterType type, int display = 2);
00292      // Other strings will be added by insert
00293      CbcOrClpParam (std::string name, std::string help, std::string firstValue,
00294                     CbcOrClpParameterType type, int whereUsed = 7, int display = 2);
00295      // Action
00296      CbcOrClpParam (std::string name, std::string help,
00297                     CbcOrClpParameterType type, int whereUsed = 7, int display = 2);
00299      CbcOrClpParam(const CbcOrClpParam &);
00301      CbcOrClpParam & operator=(const CbcOrClpParam & rhs);
00303      ~CbcOrClpParam (  );
00305 
00308 
00309      void append(std::string keyWord);
00311      void addHelp(std::string keyWord);
00313      inline std::string  name(  ) const {
00314           return name_;
00315      }
00317      inline std::string  shortHelp(  ) const {
00318           return shortHelp_;
00319      }
00321      int setDoubleParameter(CbcModel & model, double value) ;
00323      const char * setDoubleParameterWithMessage ( CbcModel & model, double  value , int & returnCode);
00325      double doubleParameter(CbcModel & model) const;
00327      int setIntParameter(CbcModel & model, int value) ;
00329      const char * setIntParameterWithMessage ( CbcModel & model, int value , int & returnCode);
00331      int intParameter(CbcModel & model) const;
00333      int setDoubleParameter(ClpSimplex * model, double value) ;
00335      double doubleParameter(ClpSimplex * model) const;
00337      const char * setDoubleParameterWithMessage ( ClpSimplex * model, double  value , int & returnCode);
00339      int setIntParameter(ClpSimplex * model, int value) ;
00341      const char * setIntParameterWithMessage ( ClpSimplex * model, int  value , int & returnCode);
00343      int intParameter(ClpSimplex * model) const;
00345      int setDoubleParameter(OsiSolverInterface * model, double value) ;
00347      const char * setDoubleParameterWithMessage ( OsiSolverInterface * model, double  value , int & returnCode);
00349      double doubleParameter(OsiSolverInterface * model) const;
00351      int setIntParameter(OsiSolverInterface * model, int value) ;
00353      const char * setIntParameterWithMessage ( OsiSolverInterface * model, int  value , int & returnCode);
00355      int intParameter(OsiSolverInterface * model) const;
00357      int checkDoubleParameter(double value) const;
00359      std::string matchName (  ) const;
00361      int lengthMatchName (  ) const;
00363      int parameterOption ( std::string check ) const;
00365      void printOptions (  ) const;
00367      inline std::string currentOption (  ) const {
00368           return definedKeyWords_[currentKeyWord_];
00369      }
00371      void setCurrentOption ( int value , bool printIt = false);
00373      const char * setCurrentOptionWithMessage ( int value );
00375      void setCurrentOption (const std::string value );
00377      inline int currentOptionAsInteger (  ) const {
00378           return currentKeyWord_;
00379      }
00381      void setIntValue ( int value );
00382      inline int intValue () const {
00383           return intValue_;
00384      }
00386      void setDoubleValue ( double value );
00387      inline double doubleValue () const {
00388           return doubleValue_;
00389      }
00391      void setStringValue ( std::string value );
00392      inline std::string stringValue () const {
00393           return stringValue_;
00394      }
00396      int matches (std::string input) const;
00398      inline CbcOrClpParameterType type() const {
00399           return type_;
00400      }
00402      inline int displayThis() const {
00403           return display_;
00404      }
00406      inline void setLonghelp(const std::string help) {
00407           longHelp_ = help;
00408      }
00410      void printLongHelp() const;
00412      void printString() const;
00418      inline int whereUsed() const {
00419           return whereUsed_;
00420      }
00421 
00422 private:
00424      void gutsOfConstructor();
00426 
00427 private:
00428 
00433      // Type see CbcOrClpParameterType
00434      CbcOrClpParameterType type_;
00436      double lowerDoubleValue_;
00437      double upperDoubleValue_;
00439      int lowerIntValue_;
00440      int upperIntValue_;
00441      // Length of name
00442      unsigned int lengthName_;
00443      // Minimum match
00444      unsigned int lengthMatch_;
00446      std::vector<std::string> definedKeyWords_;
00448      std::string name_;
00450      std::string shortHelp_;
00452      std::string longHelp_;
00454      CbcOrClpParameterType action_;
00456      int currentKeyWord_;
00458      int display_;
00460      int intValue_;
00462      double doubleValue_;
00464      std::string stringValue_;
00470      int whereUsed_;
00472 };
00474 std::string CoinReadNextField();
00475 
00476 std::string CoinReadGetCommand(int argc, const char *argv[]);
00477 std::string CoinReadGetString(int argc, const char *argv[]);
00478 // valid 0 - okay, 1 bad, 2 not there
00479 int CoinReadGetIntField(int argc, const char *argv[], int * valid);
00480 double CoinReadGetDoubleField(int argc, const char *argv[], int * valid);
00481 void CoinReadPrintit(const char * input);
00482 void setCbcOrClpPrinting(bool yesNo);
00483 #define CBCMAXPARAMETERS 250
00484 /*
00485   Subroutine to establish the cbc parameter array. See the description of
00486   class CbcOrClpParam for details. Pulled from C..Main() for clarity.
00487 */
00488 void establishParams (int &numberParameters, CbcOrClpParam *const parameters);
00489 // Given a parameter type - returns its number in list
00490 int whichParam (CbcOrClpParameterType name,
00491                 int numberParameters, CbcOrClpParam *const parameters);
00492 // Dump a solution to file
00493 void saveSolution(const ClpSimplex * lpSolver, std::string fileName);
00494 #endif  /* CbcOrClpParam_H */