00001
00002
00003
00004
00005
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
00104 CBC_PARAM_INT_STRONGBRANCHING = 151,
00105 CBC_PARAM_INT_CUTDEPTH,
00106 CBC_PARAM_INT_MAXNODES,
00107 CBC_PARAM_INT_NUMBERBEFORE,
00108 CBC_PARAM_INT_NUMBERANALYZE,
00109 CBC_PARAM_INT_MIPOPTIONS,
00110 CBC_PARAM_INT_MOREMIPOPTIONS,
00111 CBC_PARAM_INT_MAXHOTITS,
00112 CBC_PARAM_INT_FPUMPITS,
00113 CBC_PARAM_INT_MAXSOLS,
00114 CBC_PARAM_INT_FPUMPTUNE,
00115 CBC_PARAM_INT_TESTOSI,
00116 CBC_PARAM_INT_EXTRA1,
00117 CBC_PARAM_INT_EXTRA2,
00118 CBC_PARAM_INT_EXTRA3,
00119 CBC_PARAM_INT_EXTRA4,
00120 CBC_PARAM_INT_DEPTHMINIBAB,
00121 CBC_PARAM_INT_CUTPASSINTREE,
00122 CBC_PARAM_INT_THREADS,
00123 CBC_PARAM_INT_CUTPASS,
00124 CBC_PARAM_INT_VUBTRY,
00125 CBC_PARAM_INT_DENSE,
00126 CBC_PARAM_INT_EXPERIMENT,
00127 CBC_PARAM_INT_DIVEOPT,
00128 CBC_PARAM_INT_STRATEGY,
00129 CBC_PARAM_INT_SMALLFACT,
00130 CBC_PARAM_INT_HOPTIONS,
00131 CBC_PARAM_INT_CUTLENGTH,
00132 CBC_PARAM_INT_FPUMPTUNE2,
00133 #ifdef COIN_HAS_CBC
00134 CLP_PARAM_INT_LOGLEVEL ,
00135 #endif
00136 CBC_PARAM_INT_MAXSAVEDSOLS,
00137
00138 CLP_PARAM_STR_DIRECTION = 201,
00139 CLP_PARAM_STR_DUALPIVOT,
00140 CLP_PARAM_STR_SCALING,
00141 CLP_PARAM_STR_ERRORSALLOWED,
00142 CLP_PARAM_STR_KEEPNAMES,
00143 CLP_PARAM_STR_SPARSEFACTOR,
00144 CLP_PARAM_STR_PRIMALPIVOT,
00145 CLP_PARAM_STR_PRESOLVE,
00146 CLP_PARAM_STR_CRASH,
00147 CLP_PARAM_STR_BIASLU,
00148 CLP_PARAM_STR_PERTURBATION,
00149 CLP_PARAM_STR_MESSAGES,
00150 CLP_PARAM_STR_AUTOSCALE,
00151 CLP_PARAM_STR_CHOLESKY,
00152 CLP_PARAM_STR_KKT,
00153 CLP_PARAM_STR_BARRIERSCALE,
00154 CLP_PARAM_STR_GAMMA,
00155 CLP_PARAM_STR_CROSSOVER,
00156 CLP_PARAM_STR_PFI,
00157 CLP_PARAM_STR_INTPRINT,
00158 CLP_PARAM_STR_VECTOR,
00159 CLP_PARAM_STR_FACTORIZATION,
00160 CLP_PARAM_STR_ALLCOMMANDS,
00161 CLP_PARAM_STR_TIME_MODE,
00162
00163 CBC_PARAM_STR_NODESTRATEGY = 251,
00164 CBC_PARAM_STR_BRANCHSTRATEGY,
00165 CBC_PARAM_STR_CUTSSTRATEGY,
00166 CBC_PARAM_STR_HEURISTICSTRATEGY,
00167 CBC_PARAM_STR_GOMORYCUTS,
00168 CBC_PARAM_STR_PROBINGCUTS,
00169 CBC_PARAM_STR_KNAPSACKCUTS,
00170 CBC_PARAM_STR_REDSPLITCUTS,
00171 CBC_PARAM_STR_ROUNDING,
00172 CBC_PARAM_STR_SOLVER,
00173 CBC_PARAM_STR_CLIQUECUTS,
00174 CBC_PARAM_STR_COSTSTRATEGY,
00175 CBC_PARAM_STR_FLOWCUTS,
00176 CBC_PARAM_STR_MIXEDCUTS,
00177 CBC_PARAM_STR_TWOMIRCUTS,
00178 CBC_PARAM_STR_PREPROCESS,
00179 CBC_PARAM_STR_FPUMP,
00180 CBC_PARAM_STR_GREEDY,
00181 CBC_PARAM_STR_COMBINE,
00182 CBC_PARAM_STR_LOCALTREE,
00183 CBC_PARAM_STR_SOS,
00184 CBC_PARAM_STR_LANDPCUTS,
00185 CBC_PARAM_STR_RINS,
00186 CBC_PARAM_STR_RESIDCUTS,
00187 CBC_PARAM_STR_RENS,
00188 CBC_PARAM_STR_DIVINGS,
00189 CBC_PARAM_STR_DIVINGC,
00190 CBC_PARAM_STR_DIVINGF,
00191 CBC_PARAM_STR_DIVINGG,
00192 CBC_PARAM_STR_DIVINGL,
00193 CBC_PARAM_STR_DIVINGP,
00194 CBC_PARAM_STR_DIVINGV,
00195 CBC_PARAM_STR_DINS,
00196 CBC_PARAM_STR_PIVOTANDFIX,
00197 CBC_PARAM_STR_RANDROUND,
00198 CBC_PARAM_STR_NAIVE,
00199 CBC_PARAM_STR_ZEROHALFCUTS,
00200 CBC_PARAM_STR_CPX,
00201 CBC_PARAM_STR_CROSSOVER2,
00202 CBC_PARAM_STR_PIVOTANDCOMPLEMENT,
00203 CBC_PARAM_STR_VND,
00204 CBC_PARAM_STR_LAGOMORYCUTS,
00205
00206 CLP_PARAM_ACTION_DIRECTORY = 301,
00207 CLP_PARAM_ACTION_DIRSAMPLE,
00208 CLP_PARAM_ACTION_DIRNETLIB,
00209 CBC_PARAM_ACTION_DIRMIPLIB,
00210 CLP_PARAM_ACTION_IMPORT,
00211 CLP_PARAM_ACTION_EXPORT,
00212 CLP_PARAM_ACTION_RESTORE,
00213 CLP_PARAM_ACTION_SAVE,
00214 CLP_PARAM_ACTION_DUALSIMPLEX,
00215 CLP_PARAM_ACTION_PRIMALSIMPLEX,
00216 CLP_PARAM_ACTION_EITHERSIMPLEX,
00217 CLP_PARAM_ACTION_MAXIMIZE,
00218 CLP_PARAM_ACTION_MINIMIZE,
00219 CLP_PARAM_ACTION_EXIT,
00220 CLP_PARAM_ACTION_STDIN,
00221 CLP_PARAM_ACTION_UNITTEST,
00222 CLP_PARAM_ACTION_NETLIB_EITHER,
00223 CLP_PARAM_ACTION_NETLIB_DUAL,
00224 CLP_PARAM_ACTION_NETLIB_PRIMAL,
00225 CLP_PARAM_ACTION_SOLUTION,
00226 CLP_PARAM_ACTION_SAVESOL,
00227 CLP_PARAM_ACTION_TIGHTEN,
00228 CLP_PARAM_ACTION_FAKEBOUND,
00229 CLP_PARAM_ACTION_HELP,
00230 CLP_PARAM_ACTION_PLUSMINUS,
00231 CLP_PARAM_ACTION_NETWORK,
00232 CLP_PARAM_ACTION_ALLSLACK,
00233 CLP_PARAM_ACTION_REVERSE,
00234 CLP_PARAM_ACTION_BARRIER,
00235 CLP_PARAM_ACTION_NETLIB_BARRIER,
00236 CLP_PARAM_ACTION_NETLIB_TUNE,
00237 CLP_PARAM_ACTION_REALLY_SCALE,
00238 CLP_PARAM_ACTION_BASISIN,
00239 CLP_PARAM_ACTION_BASISOUT,
00240 CLP_PARAM_ACTION_SOLVECONTINUOUS,
00241 CLP_PARAM_ACTION_CLEARCUTS,
00242 CLP_PARAM_ACTION_VERSION,
00243 CLP_PARAM_ACTION_STATISTICS,
00244 CLP_PARAM_ACTION_DEBUG,
00245 CLP_PARAM_ACTION_DUMMY,
00246 CLP_PARAM_ACTION_PRINTMASK,
00247 CLP_PARAM_ACTION_OUTDUPROWS,
00248 CLP_PARAM_ACTION_USERCLP,
00249 CLP_PARAM_ACTION_MODELIN,
00250 CLP_PARAM_ACTION_CSVSTATISTICS,
00251 CLP_PARAM_ACTION_STOREDFILE,
00252 CLP_PARAM_ACTION_ENVIRONMENT,
00253 CLP_PARAM_ACTION_PARAMETRICS,
00254 CLP_PARAM_ACTION_GMPL_SOLUTION,
00255
00256 CBC_PARAM_ACTION_BAB = 351,
00257 CBC_PARAM_ACTION_MIPLIB,
00258 CBC_PARAM_ACTION_STRENGTHEN,
00259 CBC_PARAM_ACTION_PRIORITYIN,
00260 CBC_PARAM_ACTION_MIPSTART,
00261 CBC_PARAM_ACTION_USERCBC,
00262 CBC_PARAM_ACTION_DOHEURISTIC,
00263 CLP_PARAM_ACTION_NEXTBESTSOLUTION,
00264
00265 CBC_PARAM_NOTUSED_OSLSTUFF = 401,
00266 CBC_PARAM_NOTUSED_CBCSTUFF,
00267
00268 CBC_PARAM_NOTUSED_INVALID = 1000
00269 } ;
00270 #include <vector>
00271 #include <string>
00272
00274
00275 class CbcOrClpParam {
00276 public:
00279
00280 CbcOrClpParam ( );
00281 CbcOrClpParam (std::string name, std::string help,
00282 double lower, double upper, CbcOrClpParameterType type, int display = 2);
00283 CbcOrClpParam (std::string name, std::string help,
00284 int lower, int upper, CbcOrClpParameterType type, int display = 2);
00285
00286 CbcOrClpParam (std::string name, std::string help, std::string firstValue,
00287 CbcOrClpParameterType type, int whereUsed = 7, int display = 2);
00288
00289 CbcOrClpParam (std::string name, std::string help,
00290 CbcOrClpParameterType type, int whereUsed = 7, int display = 2);
00292 CbcOrClpParam(const CbcOrClpParam &);
00294 CbcOrClpParam & operator=(const CbcOrClpParam & rhs);
00296 ~CbcOrClpParam ( );
00298
00301
00302 void append(std::string keyWord);
00304 void addHelp(std::string keyWord);
00306 inline std::string name( ) const {
00307 return name_;
00308 }
00310 inline std::string shortHelp( ) const {
00311 return shortHelp_;
00312 }
00314 int setDoubleParameter(CbcModel & model, double value) ;
00316 const char * setDoubleParameterWithMessage ( CbcModel & model, double value , int & returnCode);
00318 double doubleParameter(CbcModel & model) const;
00320 int setIntParameter(CbcModel & model, int value) ;
00322 const char * setIntParameterWithMessage ( CbcModel & model, int value , int & returnCode);
00324 int intParameter(CbcModel & model) const;
00326 int setDoubleParameter(ClpSimplex * model, double value) ;
00328 double doubleParameter(ClpSimplex * model) const;
00330 const char * setDoubleParameterWithMessage ( ClpSimplex * model, double value , int & returnCode);
00332 int setIntParameter(ClpSimplex * model, int value) ;
00334 const char * setIntParameterWithMessage ( ClpSimplex * model, int value , int & returnCode);
00336 int intParameter(ClpSimplex * model) const;
00338 int setDoubleParameter(OsiSolverInterface * model, double value) ;
00340 const char * setDoubleParameterWithMessage ( OsiSolverInterface * model, double value , int & returnCode);
00342 double doubleParameter(OsiSolverInterface * model) const;
00344 int setIntParameter(OsiSolverInterface * model, int value) ;
00346 const char * setIntParameterWithMessage ( OsiSolverInterface * model, int value , int & returnCode);
00348 int intParameter(OsiSolverInterface * model) const;
00350 int checkDoubleParameter(double value) const;
00352 std::string matchName ( ) const;
00354 int lengthMatchName ( ) const;
00356 int parameterOption ( std::string check ) const;
00358 void printOptions ( ) const;
00360 inline std::string currentOption ( ) const {
00361 return definedKeyWords_[currentKeyWord_];
00362 }
00364 void setCurrentOption ( int value , bool printIt = false);
00366 const char * setCurrentOptionWithMessage ( int value );
00368 void setCurrentOption (const std::string value );
00370 inline int currentOptionAsInteger ( ) const {
00371 return currentKeyWord_;
00372 }
00374 void setIntValue ( int value );
00375 inline int intValue () const {
00376 return intValue_;
00377 }
00379 void setDoubleValue ( double value );
00380 inline double doubleValue () const {
00381 return doubleValue_;
00382 }
00384 void setStringValue ( std::string value );
00385 inline std::string stringValue () const {
00386 return stringValue_;
00387 }
00389 int matches (std::string input) const;
00391 inline CbcOrClpParameterType type() const {
00392 return type_;
00393 }
00395 inline int displayThis() const {
00396 return display_;
00397 }
00399 inline void setLonghelp(const std::string help) {
00400 longHelp_ = help;
00401 }
00403 void printLongHelp() const;
00405 void printString() const;
00411 inline int whereUsed() const {
00412 return whereUsed_;
00413 }
00414
00415 private:
00417 void gutsOfConstructor();
00419
00420 private:
00421
00426
00427 CbcOrClpParameterType type_;
00429 double lowerDoubleValue_;
00430 double upperDoubleValue_;
00432 int lowerIntValue_;
00433 int upperIntValue_;
00434
00435 unsigned int lengthName_;
00436
00437 unsigned int lengthMatch_;
00439 std::vector<std::string> definedKeyWords_;
00441 std::string name_;
00443 std::string shortHelp_;
00445 std::string longHelp_;
00447 CbcOrClpParameterType action_;
00449 int currentKeyWord_;
00451 int display_;
00453 int intValue_;
00455 double doubleValue_;
00457 std::string stringValue_;
00463 int whereUsed_;
00465 };
00467 std::string CoinReadNextField();
00468
00469 std::string CoinReadGetCommand(int argc, const char *argv[]);
00470 std::string CoinReadGetString(int argc, const char *argv[]);
00471
00472 int CoinReadGetIntField(int argc, const char *argv[], int * valid);
00473 double CoinReadGetDoubleField(int argc, const char *argv[], int * valid);
00474 void CoinReadPrintit(const char * input);
00475 void setCbcOrClpPrinting(bool yesNo);
00476 #define CBCMAXPARAMETERS 200
00477
00478
00479
00480
00481 void establishParams (int &numberParameters, CbcOrClpParam *const parameters);
00482
00483 int whichParam (CbcOrClpParameterType name,
00484 int numberParameters, CbcOrClpParam *const parameters);
00485
00486 void saveSolution(const ClpSimplex * lpSolver, std::string fileName);
00487 #endif