00001
00002
00003
00004
00005
00006 #ifdef USE_CBCCONFIG
00007 # include "CbcConfig.h"
00008 #else
00009 # include "ClpConfig.h"
00010 #endif
00011
00012 #ifndef CbcOrClpParam_H
00013 #define CbcOrClpParam_H
00014
00026 class OsiSolverInterface;
00027 class CbcModel;
00028 class ClpSimplex;
00046 enum CbcOrClpParameterType
00047
00048 {
00049 CBC_PARAM_GENERALQUERY = -100,
00050 CBC_PARAM_FULLGENERALQUERY,
00051
00052 CLP_PARAM_DBL_PRIMALTOLERANCE = 1,
00053 CLP_PARAM_DBL_DUALTOLERANCE,
00054 CLP_PARAM_DBL_TIMELIMIT,
00055 CLP_PARAM_DBL_DUALBOUND,
00056 CLP_PARAM_DBL_PRIMALWEIGHT,
00057 CLP_PARAM_DBL_OBJSCALE,
00058 CLP_PARAM_DBL_RHSSCALE,
00059
00060 CBC_PARAM_DBL_INFEASIBILITYWEIGHT = 51,
00061 CBC_PARAM_DBL_CUTOFF,
00062 CBC_PARAM_DBL_INTEGERTOLERANCE,
00063 CBC_PARAM_DBL_INCREMENT,
00064 CBC_PARAM_DBL_ALLOWABLEGAP,
00065 CBC_PARAM_DBL_TIMELIMIT_BAB,
00066 CBC_PARAM_DBL_GAPRATIO,
00067
00068 CBC_PARAM_DBL_DJFIX = 81,
00069 CBC_PARAM_DBL_TIGHTENFACTOR,
00070 CLP_PARAM_DBL_PRESOLVETOLERANCE,
00071 CLP_PARAM_DBL_OBJSCALE2,
00072 CBC_PARAM_DBL_FAKEINCREMENT,
00073 CBC_PARAM_DBL_FAKECUTOFF,
00074 CBC_PARAM_DBL_ARTIFICIALCOST,
00075 CBC_PARAM_DBL_DEXTRA3,
00076 CBC_PARAM_DBL_SMALLBAB,
00077 CBC_PARAM_DBL_DEXTRA4,
00078 CBC_PARAM_DBL_DEXTRA5,
00079
00080 CLP_PARAM_INT_SOLVERLOGLEVEL = 101,
00081 #ifndef COIN_HAS_CBC
00082 CLP_PARAM_INT_LOGLEVEL = 101,
00083 #endif
00084 CLP_PARAM_INT_MAXFACTOR,
00085 CLP_PARAM_INT_PERTVALUE,
00086 CLP_PARAM_INT_MAXITERATION,
00087 CLP_PARAM_INT_PRESOLVEPASS,
00088 CLP_PARAM_INT_IDIOT,
00089 CLP_PARAM_INT_SPRINT,
00090 CLP_PARAM_INT_OUTPUTFORMAT,
00091 CLP_PARAM_INT_SLPVALUE,
00092 CLP_PARAM_INT_PRESOLVEOPTIONS,
00093 CLP_PARAM_INT_PRINTOPTIONS,
00094 CLP_PARAM_INT_SPECIALOPTIONS,
00095 CLP_PARAM_INT_SUBSTITUTION,
00096 CLP_PARAM_INT_DUALIZE,
00097 CLP_PARAM_INT_VERBOSE,
00098 CLP_PARAM_INT_CPP,
00099 CLP_PARAM_INT_PROCESSTUNE,
00100 CLP_PARAM_INT_USESOLUTION,
00101
00102 CBC_PARAM_INT_STRONGBRANCHING = 151,
00103 CBC_PARAM_INT_CUTDEPTH,
00104 CBC_PARAM_INT_MAXNODES,
00105 CBC_PARAM_INT_NUMBERBEFORE,
00106 CBC_PARAM_INT_NUMBERANALYZE,
00107 CBC_PARAM_INT_MIPOPTIONS,
00108 CBC_PARAM_INT_MOREMIPOPTIONS,
00109 CBC_PARAM_INT_MAXHOTITS,
00110 CBC_PARAM_INT_FPUMPITS,
00111 CBC_PARAM_INT_MAXSOLS,
00112 CBC_PARAM_INT_FPUMPTUNE,
00113 CBC_PARAM_INT_TESTOSI,
00114 CBC_PARAM_INT_EXTRA1,
00115 CBC_PARAM_INT_EXTRA2,
00116 CBC_PARAM_INT_EXTRA3,
00117 CBC_PARAM_INT_EXTRA4,
00118 CBC_PARAM_INT_DEPTHMINIBAB,
00119 CBC_PARAM_INT_CUTPASSINTREE,
00120 CBC_PARAM_INT_THREADS,
00121 CBC_PARAM_INT_CUTPASS,
00122 CBC_PARAM_INT_VUBTRY,
00123 CBC_PARAM_INT_DENSE,
00124 CBC_PARAM_INT_EXPERIMENT,
00125 CBC_PARAM_INT_DIVEOPT,
00126 CBC_PARAM_INT_STRATEGY,
00127 CBC_PARAM_INT_SMALLFACT,
00128 CBC_PARAM_INT_HOPTIONS,
00129 CBC_PARAM_INT_CUTLENGTH,
00130 CBC_PARAM_INT_FPUMPTUNE2,
00131 #ifdef COIN_HAS_CBC
00132 CLP_PARAM_INT_LOGLEVEL ,
00133 #endif
00134
00135 CLP_PARAM_STR_DIRECTION = 201,
00136 CLP_PARAM_STR_DUALPIVOT,
00137 CLP_PARAM_STR_SCALING,
00138 CLP_PARAM_STR_ERRORSALLOWED,
00139 CLP_PARAM_STR_KEEPNAMES,
00140 CLP_PARAM_STR_SPARSEFACTOR,
00141 CLP_PARAM_STR_PRIMALPIVOT,
00142 CLP_PARAM_STR_PRESOLVE,
00143 CLP_PARAM_STR_CRASH,
00144 CLP_PARAM_STR_BIASLU,
00145 CLP_PARAM_STR_PERTURBATION,
00146 CLP_PARAM_STR_MESSAGES,
00147 CLP_PARAM_STR_AUTOSCALE,
00148 CLP_PARAM_STR_CHOLESKY,
00149 CLP_PARAM_STR_KKT,
00150 CLP_PARAM_STR_BARRIERSCALE,
00151 CLP_PARAM_STR_GAMMA,
00152 CLP_PARAM_STR_CROSSOVER,
00153 CLP_PARAM_STR_PFI,
00154 CLP_PARAM_STR_INTPRINT,
00155 CLP_PARAM_STR_VECTOR,
00156 CLP_PARAM_STR_FACTORIZATION,
00157 CLP_PARAM_STR_ALLCOMMANDS,
00158 CLP_PARAM_STR_TIME_MODE,
00159
00160 CBC_PARAM_STR_NODESTRATEGY = 251,
00161 CBC_PARAM_STR_BRANCHSTRATEGY,
00162 CBC_PARAM_STR_CUTSSTRATEGY,
00163 CBC_PARAM_STR_HEURISTICSTRATEGY,
00164 CBC_PARAM_STR_GOMORYCUTS,
00165 CBC_PARAM_STR_PROBINGCUTS,
00166 CBC_PARAM_STR_KNAPSACKCUTS,
00167 CBC_PARAM_STR_REDSPLITCUTS,
00168 CBC_PARAM_STR_ROUNDING,
00169 CBC_PARAM_STR_SOLVER,
00170 CBC_PARAM_STR_CLIQUECUTS,
00171 CBC_PARAM_STR_COSTSTRATEGY,
00172 CBC_PARAM_STR_FLOWCUTS,
00173 CBC_PARAM_STR_MIXEDCUTS,
00174 CBC_PARAM_STR_TWOMIRCUTS,
00175 CBC_PARAM_STR_PREPROCESS,
00176 CBC_PARAM_STR_FPUMP,
00177 CBC_PARAM_STR_GREEDY,
00178 CBC_PARAM_STR_COMBINE,
00179 CBC_PARAM_STR_LOCALTREE,
00180 CBC_PARAM_STR_SOS,
00181 CBC_PARAM_STR_LANDPCUTS,
00182 CBC_PARAM_STR_RINS,
00183 CBC_PARAM_STR_RESIDCUTS,
00184 CBC_PARAM_STR_RENS,
00185 CBC_PARAM_STR_DIVINGS,
00186 CBC_PARAM_STR_DIVINGC,
00187 CBC_PARAM_STR_DIVINGF,
00188 CBC_PARAM_STR_DIVINGG,
00189 CBC_PARAM_STR_DIVINGL,
00190 CBC_PARAM_STR_DIVINGP,
00191 CBC_PARAM_STR_DIVINGV,
00192 CBC_PARAM_STR_DINS,
00193 CBC_PARAM_STR_PIVOTANDFIX,
00194 CBC_PARAM_STR_RANDROUND,
00195 CBC_PARAM_STR_NAIVE,
00196 CBC_PARAM_STR_ZEROHALFCUTS,
00197 CBC_PARAM_STR_CPX,
00198 CBC_PARAM_STR_CROSSOVER2,
00199 CBC_PARAM_STR_PIVOTANDCOMPLEMENT,
00200 CBC_PARAM_STR_VND,
00201
00202 CLP_PARAM_ACTION_DIRECTORY = 301,
00203 CLP_PARAM_ACTION_DIRSAMPLE,
00204 CLP_PARAM_ACTION_DIRNETLIB,
00205 CBC_PARAM_ACTION_DIRMIPLIB,
00206 CLP_PARAM_ACTION_IMPORT,
00207 CLP_PARAM_ACTION_EXPORT,
00208 CLP_PARAM_ACTION_RESTORE,
00209 CLP_PARAM_ACTION_SAVE,
00210 CLP_PARAM_ACTION_DUALSIMPLEX,
00211 CLP_PARAM_ACTION_PRIMALSIMPLEX,
00212 CLP_PARAM_ACTION_EITHERSIMPLEX,
00213 CLP_PARAM_ACTION_MAXIMIZE,
00214 CLP_PARAM_ACTION_MINIMIZE,
00215 CLP_PARAM_ACTION_EXIT,
00216 CLP_PARAM_ACTION_STDIN,
00217 CLP_PARAM_ACTION_UNITTEST,
00218 CLP_PARAM_ACTION_NETLIB_EITHER,
00219 CLP_PARAM_ACTION_NETLIB_DUAL,
00220 CLP_PARAM_ACTION_NETLIB_PRIMAL,
00221 CLP_PARAM_ACTION_SOLUTION,
00222 CLP_PARAM_ACTION_SAVESOL,
00223 CLP_PARAM_ACTION_TIGHTEN,
00224 CLP_PARAM_ACTION_FAKEBOUND,
00225 CLP_PARAM_ACTION_HELP,
00226 CLP_PARAM_ACTION_PLUSMINUS,
00227 CLP_PARAM_ACTION_NETWORK,
00228 CLP_PARAM_ACTION_ALLSLACK,
00229 CLP_PARAM_ACTION_REVERSE,
00230 CLP_PARAM_ACTION_BARRIER,
00231 CLP_PARAM_ACTION_NETLIB_BARRIER,
00232 CLP_PARAM_ACTION_NETLIB_TUNE,
00233 CLP_PARAM_ACTION_REALLY_SCALE,
00234 CLP_PARAM_ACTION_BASISIN,
00235 CLP_PARAM_ACTION_BASISOUT,
00236 CLP_PARAM_ACTION_SOLVECONTINUOUS,
00237 CLP_PARAM_ACTION_CLEARCUTS,
00238 CLP_PARAM_ACTION_VERSION,
00239 CLP_PARAM_ACTION_STATISTICS,
00240 CLP_PARAM_ACTION_DEBUG,
00241 CLP_PARAM_ACTION_DUMMY,
00242 CLP_PARAM_ACTION_PRINTMASK,
00243 CLP_PARAM_ACTION_OUTDUPROWS,
00244 CLP_PARAM_ACTION_USERCLP,
00245 CLP_PARAM_ACTION_MODELIN,
00246 CLP_PARAM_ACTION_CSVSTATISTICS,
00247 CLP_PARAM_ACTION_STOREDFILE,
00248 CLP_PARAM_ACTION_ENVIRONMENT,
00249
00250 CBC_PARAM_ACTION_BAB = 351,
00251 CBC_PARAM_ACTION_MIPLIB,
00252 CBC_PARAM_ACTION_STRENGTHEN,
00253 CBC_PARAM_ACTION_PRIORITYIN,
00254 CBC_PARAM_ACTION_USERCBC,
00255 CBC_PARAM_ACTION_DOHEURISTIC,
00256
00257 CBC_PARAM_NOTUSED_OSLSTUFF = 401,
00258 CBC_PARAM_NOTUSED_CBCSTUFF,
00259
00260 CBC_PARAM_NOTUSED_INVALID = 1000
00261 } ;
00262 #include <vector>
00263 #include <string>
00264
00266
00267 class CbcOrClpParam {
00268 public:
00271
00272 CbcOrClpParam ( );
00273 CbcOrClpParam (std::string name, std::string help,
00274 double lower, double upper, CbcOrClpParameterType type, int display = 2);
00275 CbcOrClpParam (std::string name, std::string help,
00276 int lower, int upper, CbcOrClpParameterType type, int display = 2);
00277
00278 CbcOrClpParam (std::string name, std::string help, std::string firstValue,
00279 CbcOrClpParameterType type, int whereUsed = 7, int display = 2);
00280
00281 CbcOrClpParam (std::string name, std::string help,
00282 CbcOrClpParameterType type, int whereUsed = 7, int display = 2);
00284 CbcOrClpParam(const CbcOrClpParam &);
00286 CbcOrClpParam & operator=(const CbcOrClpParam & rhs);
00288 ~CbcOrClpParam ( );
00290
00293
00294 void append(std::string keyWord);
00296 void addHelp(std::string keyWord);
00298 inline std::string name( ) const {
00299 return name_;
00300 }
00302 inline std::string shortHelp( ) const {
00303 return shortHelp_;
00304 }
00306 int setDoubleParameter(CbcModel & model, double value) ;
00308 const char * setDoubleParameterWithMessage ( CbcModel & model, double value , int & returnCode);
00310 double doubleParameter(CbcModel & model) const;
00312 int setIntParameter(CbcModel & model, int value) ;
00314 const char * setIntParameterWithMessage ( CbcModel & model, int value , int & returnCode);
00316 int intParameter(CbcModel & model) const;
00318 int setDoubleParameter(ClpSimplex * model, double value) ;
00320 double doubleParameter(ClpSimplex * model) const;
00322 const char * setDoubleParameterWithMessage ( ClpSimplex * model, double value , int & returnCode);
00324 int setIntParameter(ClpSimplex * model, int value) ;
00326 const char * setIntParameterWithMessage ( ClpSimplex * model, int value , int & returnCode);
00328 int intParameter(ClpSimplex * model) const;
00330 int setDoubleParameter(OsiSolverInterface * model, double value) ;
00332 const char * setDoubleParameterWithMessage ( OsiSolverInterface * model, double value , int & returnCode);
00334 double doubleParameter(OsiSolverInterface * model) const;
00336 int setIntParameter(OsiSolverInterface * model, int value) ;
00338 const char * setIntParameterWithMessage ( OsiSolverInterface * model, int value , int & returnCode);
00340 int intParameter(OsiSolverInterface * model) const;
00342 int checkDoubleParameter(double value) const;
00344 std::string matchName ( ) const;
00346 int lengthMatchName ( ) const;
00348 int parameterOption ( std::string check ) const;
00350 void printOptions ( ) const;
00352 inline std::string currentOption ( ) const {
00353 return definedKeyWords_[currentKeyWord_];
00354 }
00356 void setCurrentOption ( int value , bool printIt = false);
00358 const char * setCurrentOptionWithMessage ( int value );
00360 void setCurrentOption (const std::string value );
00362 inline int currentOptionAsInteger ( ) const {
00363 return currentKeyWord_;
00364 }
00366 void setIntValue ( int value );
00367 inline int intValue () const {
00368 return intValue_;
00369 }
00371 void setDoubleValue ( double value );
00372 inline double doubleValue () const {
00373 return doubleValue_;
00374 }
00376 void setStringValue ( std::string value );
00377 inline std::string stringValue () const {
00378 return stringValue_;
00379 }
00381 int matches (std::string input) const;
00383 inline CbcOrClpParameterType type() const {
00384 return type_;
00385 }
00387 inline int displayThis() const {
00388 return display_;
00389 }
00391 inline void setLonghelp(const std::string help) {
00392 longHelp_ = help;
00393 }
00395 void printLongHelp() const;
00397 void printString() const;
00403 inline int whereUsed() const {
00404 return whereUsed_;
00405 }
00406
00407 private:
00409 void gutsOfConstructor();
00411
00412 private:
00413
00418
00419 CbcOrClpParameterType type_;
00421 double lowerDoubleValue_;
00422 double upperDoubleValue_;
00424 int lowerIntValue_;
00425 int upperIntValue_;
00426
00427 unsigned int lengthName_;
00428
00429 unsigned int lengthMatch_;
00431 std::vector<std::string> definedKeyWords_;
00433 std::string name_;
00435 std::string shortHelp_;
00437 std::string longHelp_;
00439 CbcOrClpParameterType action_;
00441 int currentKeyWord_;
00443 int display_;
00445 int intValue_;
00447 double doubleValue_;
00449 std::string stringValue_;
00455 int whereUsed_;
00457 };
00459 std::string CoinReadNextField();
00460
00461 std::string CoinReadGetCommand(int argc, const char *argv[]);
00462 std::string CoinReadGetString(int argc, const char *argv[]);
00463
00464 int CoinReadGetIntField(int argc, const char *argv[], int * valid);
00465 double CoinReadGetDoubleField(int argc, const char *argv[], int * valid);
00466 void CoinReadPrintit(const char * input);
00467 void setCbcOrClpPrinting(bool yesNo);
00468 #define CBCMAXPARAMETERS 200
00469
00470
00471
00472
00473 void establishParams (int &numberParameters, CbcOrClpParam *const parameters);
00474
00475 int whichParam (CbcOrClpParameterType name,
00476 int numberParameters, CbcOrClpParam *const parameters);
00477
00478 void saveSolution(const ClpSimplex * lpSolver, std::string fileName);
00479 #endif