source: trunk/Clp/src/CbcOrClpParam.hpp @ 2030

Last change on this file since 2030 was 1976, checked in by forrest, 6 years ago

allow use of plusnnnn or minusnnnn as keyword

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 17.2 KB
Line 
1
2/* $Id: CbcOrClpParam.hpp 1976 2013-08-17 15:24:16Z forrest $ */
3// Copyright (C) 2002, International Business Machines
4// Corporation and others.  All Rights Reserved.
5// This code is licensed under the terms of the Eclipse Public License (EPL).
6
7#ifdef USE_CBCCONFIG
8# include "CbcConfig.h"
9#else
10# include "ClpConfig.h"
11#endif
12
13#ifndef CbcOrClpParam_H
14#define CbcOrClpParam_H
15/**
16   This has parameter handling stuff which can be shared between Cbc and Clp (and Dylp etc).
17
18   This (and .cpp) should be copied so that it is the same in Cbc/Test and Clp/Test.
19   I know this is not elegant but it seems simplest.
20
21   It uses COIN_HAS_CBC for parameters wanted by CBC
22   It uses COIN_HAS_CLP for parameters wanted by CLP (or CBC using CLP)
23   It could use COIN_HAS_DYLP for parameters wanted by DYLP
24   It could use COIN_HAS_DYLP_OR_CLP for parameters wanted by DYLP or CLP etc etc
25
26 */
27class OsiSolverInterface;
28class CbcModel;
29class ClpSimplex;
30/*! \brief Parameter codes
31
32  Parameter type ranges are allocated as follows
33  <ul>
34    <li>   1 -- 100     double parameters
35    <li> 101 -- 200     integer parameters
36    <li> 201 -- 250     string parameters
37    <li> 251 -- 300     cuts etc(string but broken out for clarity)
38    <li> 301 -- 400     `actions'
39  </ul>
40
41  `Actions' do not necessarily invoke an immediate action; it's just that they
42  don't fit neatly into the parameters array.
43
44  This coding scheme is in flux.
45*/
46
47enum CbcOrClpParameterType
48
49{
50     CBC_PARAM_GENERALQUERY = -100,
51     CBC_PARAM_FULLGENERALQUERY,
52
53     CLP_PARAM_DBL_PRIMALTOLERANCE = 1,
54     CLP_PARAM_DBL_DUALTOLERANCE,
55     CLP_PARAM_DBL_TIMELIMIT,
56     CLP_PARAM_DBL_DUALBOUND,
57     CLP_PARAM_DBL_PRIMALWEIGHT,
58     CLP_PARAM_DBL_OBJSCALE,
59     CLP_PARAM_DBL_RHSSCALE,
60     CLP_PARAM_DBL_ZEROTOLERANCE,
61
62     CBC_PARAM_DBL_INFEASIBILITYWEIGHT = 51,
63     CBC_PARAM_DBL_CUTOFF,
64     CBC_PARAM_DBL_INTEGERTOLERANCE,
65     CBC_PARAM_DBL_INCREMENT,
66     CBC_PARAM_DBL_ALLOWABLEGAP,
67     CBC_PARAM_DBL_TIMELIMIT_BAB,
68     CBC_PARAM_DBL_GAPRATIO,
69
70     CBC_PARAM_DBL_DJFIX = 81,
71     CBC_PARAM_DBL_TIGHTENFACTOR,
72     CLP_PARAM_DBL_PRESOLVETOLERANCE,
73     CLP_PARAM_DBL_OBJSCALE2,
74     CBC_PARAM_DBL_FAKEINCREMENT,
75     CBC_PARAM_DBL_FAKECUTOFF,
76     CBC_PARAM_DBL_ARTIFICIALCOST,
77     CBC_PARAM_DBL_DEXTRA3,
78     CBC_PARAM_DBL_SMALLBAB,
79     CBC_PARAM_DBL_DEXTRA4,
80     CBC_PARAM_DBL_DEXTRA5,
81
82     CLP_PARAM_INT_SOLVERLOGLEVEL = 101,
83#ifndef COIN_HAS_CBC
84     CLP_PARAM_INT_LOGLEVEL = 101,
85#endif
86     CLP_PARAM_INT_MAXFACTOR,
87     CLP_PARAM_INT_PERTVALUE,
88     CLP_PARAM_INT_MAXITERATION,
89     CLP_PARAM_INT_PRESOLVEPASS,
90     CLP_PARAM_INT_IDIOT,
91     CLP_PARAM_INT_SPRINT,
92     CLP_PARAM_INT_OUTPUTFORMAT,
93     CLP_PARAM_INT_SLPVALUE,
94     CLP_PARAM_INT_PRESOLVEOPTIONS,
95     CLP_PARAM_INT_PRINTOPTIONS,
96     CLP_PARAM_INT_SPECIALOPTIONS,
97     CLP_PARAM_INT_SUBSTITUTION,
98     CLP_PARAM_INT_DUALIZE,
99     CLP_PARAM_INT_VERBOSE,
100     CLP_PARAM_INT_CPP,
101     CLP_PARAM_INT_PROCESSTUNE,
102     CLP_PARAM_INT_USESOLUTION,
103     CLP_PARAM_INT_RANDOMSEED,
104     CLP_PARAM_INT_MORESPECIALOPTIONS,
105     CLP_PARAM_INT_DECOMPOSE_BLOCKS,
106
107     CBC_PARAM_INT_STRONGBRANCHING = 151,
108     CBC_PARAM_INT_CUTDEPTH,
109     CBC_PARAM_INT_MAXNODES,
110     CBC_PARAM_INT_NUMBERBEFORE,
111     CBC_PARAM_INT_NUMBERANALYZE,
112     CBC_PARAM_INT_MIPOPTIONS,
113     CBC_PARAM_INT_MOREMIPOPTIONS,
114     CBC_PARAM_INT_MAXHOTITS,
115     CBC_PARAM_INT_FPUMPITS,
116     CBC_PARAM_INT_MAXSOLS,
117     CBC_PARAM_INT_FPUMPTUNE,
118     CBC_PARAM_INT_TESTOSI,
119     CBC_PARAM_INT_EXTRA1,
120     CBC_PARAM_INT_EXTRA2,
121     CBC_PARAM_INT_EXTRA3,
122     CBC_PARAM_INT_EXTRA4,
123     CBC_PARAM_INT_DEPTHMINIBAB,
124     CBC_PARAM_INT_CUTPASSINTREE,
125     CBC_PARAM_INT_THREADS,
126     CBC_PARAM_INT_CUTPASS,
127     CBC_PARAM_INT_VUBTRY,
128     CBC_PARAM_INT_DENSE,
129     CBC_PARAM_INT_EXPERIMENT,
130     CBC_PARAM_INT_DIVEOPT,
131     CBC_PARAM_INT_STRATEGY,
132     CBC_PARAM_INT_SMALLFACT,
133     CBC_PARAM_INT_HOPTIONS,
134     CBC_PARAM_INT_CUTLENGTH,
135     CBC_PARAM_INT_FPUMPTUNE2,
136#ifdef COIN_HAS_CBC
137     CLP_PARAM_INT_LOGLEVEL ,
138#endif
139     CBC_PARAM_INT_MAXSAVEDSOLS,
140     CBC_PARAM_INT_RANDOMSEED,
141     CBC_PARAM_INT_MULTIPLEROOTS,
142     CBC_PARAM_INT_STRONG_STRATEGY,
143     CBC_PARAM_INT_EXTRA_VARIABLES,
144     CBC_PARAM_INT_MAX_SLOW_CUTS,
145     CBC_PARAM_INT_MOREMOREMIPOPTIONS,
146
147     CLP_PARAM_STR_DIRECTION = 201,
148     CLP_PARAM_STR_DUALPIVOT,
149     CLP_PARAM_STR_SCALING,
150     CLP_PARAM_STR_ERRORSALLOWED,
151     CLP_PARAM_STR_KEEPNAMES,
152     CLP_PARAM_STR_SPARSEFACTOR,
153     CLP_PARAM_STR_PRIMALPIVOT,
154     CLP_PARAM_STR_PRESOLVE,
155     CLP_PARAM_STR_CRASH,
156     CLP_PARAM_STR_BIASLU,
157     CLP_PARAM_STR_PERTURBATION,
158     CLP_PARAM_STR_MESSAGES,
159     CLP_PARAM_STR_AUTOSCALE,
160     CLP_PARAM_STR_CHOLESKY,
161     CLP_PARAM_STR_KKT,
162     CLP_PARAM_STR_BARRIERSCALE,
163     CLP_PARAM_STR_GAMMA,
164     CLP_PARAM_STR_CROSSOVER,
165     CLP_PARAM_STR_PFI,
166     CLP_PARAM_STR_INTPRINT,
167     CLP_PARAM_STR_VECTOR,
168     CLP_PARAM_STR_FACTORIZATION,
169     CLP_PARAM_STR_ALLCOMMANDS,
170     CLP_PARAM_STR_TIME_MODE,
171     CLP_PARAM_STR_ABCWANTED,
172
173     CBC_PARAM_STR_NODESTRATEGY = 251,
174     CBC_PARAM_STR_BRANCHSTRATEGY,
175     CBC_PARAM_STR_CUTSSTRATEGY,
176     CBC_PARAM_STR_HEURISTICSTRATEGY,
177     CBC_PARAM_STR_GOMORYCUTS,
178     CBC_PARAM_STR_PROBINGCUTS,
179     CBC_PARAM_STR_KNAPSACKCUTS,
180     CBC_PARAM_STR_REDSPLITCUTS,
181     CBC_PARAM_STR_ROUNDING,
182     CBC_PARAM_STR_SOLVER,
183     CBC_PARAM_STR_CLIQUECUTS,
184     CBC_PARAM_STR_COSTSTRATEGY,
185     CBC_PARAM_STR_FLOWCUTS,
186     CBC_PARAM_STR_MIXEDCUTS,
187     CBC_PARAM_STR_TWOMIRCUTS,
188     CBC_PARAM_STR_PREPROCESS,
189     CBC_PARAM_STR_FPUMP,
190     CBC_PARAM_STR_GREEDY,
191     CBC_PARAM_STR_COMBINE,
192     CBC_PARAM_STR_PROXIMITY,
193     CBC_PARAM_STR_LOCALTREE,
194     CBC_PARAM_STR_SOS,
195     CBC_PARAM_STR_LANDPCUTS,
196     CBC_PARAM_STR_RINS,
197     CBC_PARAM_STR_RESIDCUTS,
198     CBC_PARAM_STR_RENS,
199     CBC_PARAM_STR_DIVINGS,
200     CBC_PARAM_STR_DIVINGC,
201     CBC_PARAM_STR_DIVINGF,
202     CBC_PARAM_STR_DIVINGG,
203     CBC_PARAM_STR_DIVINGL,
204     CBC_PARAM_STR_DIVINGP,
205     CBC_PARAM_STR_DIVINGV,
206     CBC_PARAM_STR_DINS,
207     CBC_PARAM_STR_PIVOTANDFIX,
208     CBC_PARAM_STR_RANDROUND,
209     CBC_PARAM_STR_NAIVE,
210     CBC_PARAM_STR_ZEROHALFCUTS,
211     CBC_PARAM_STR_CPX,
212     CBC_PARAM_STR_CROSSOVER2,
213     CBC_PARAM_STR_PIVOTANDCOMPLEMENT,
214     CBC_PARAM_STR_VND,
215     CBC_PARAM_STR_LAGOMORYCUTS,
216     CBC_PARAM_STR_LATWOMIRCUTS,
217     CBC_PARAM_STR_REDSPLIT2CUTS,
218     CBC_PARAM_STR_GMICUTS,
219     CBC_PARAM_STR_CUTOFF_CONSTRAINT,
220     CBC_PARAM_STR_DW,
221
222     CLP_PARAM_ACTION_DIRECTORY = 301,
223     CLP_PARAM_ACTION_DIRSAMPLE,
224     CLP_PARAM_ACTION_DIRNETLIB,
225     CBC_PARAM_ACTION_DIRMIPLIB,
226     CLP_PARAM_ACTION_IMPORT,
227     CLP_PARAM_ACTION_EXPORT,
228     CLP_PARAM_ACTION_RESTORE,
229     CLP_PARAM_ACTION_SAVE,
230     CLP_PARAM_ACTION_DUALSIMPLEX,
231     CLP_PARAM_ACTION_PRIMALSIMPLEX,
232     CLP_PARAM_ACTION_EITHERSIMPLEX,
233     CLP_PARAM_ACTION_MAXIMIZE,
234     CLP_PARAM_ACTION_MINIMIZE,
235     CLP_PARAM_ACTION_EXIT,
236     CLP_PARAM_ACTION_STDIN,
237     CLP_PARAM_ACTION_UNITTEST,
238     CLP_PARAM_ACTION_NETLIB_EITHER,
239     CLP_PARAM_ACTION_NETLIB_DUAL,
240     CLP_PARAM_ACTION_NETLIB_PRIMAL,
241     CLP_PARAM_ACTION_SOLUTION,
242     CLP_PARAM_ACTION_SAVESOL,
243     CLP_PARAM_ACTION_TIGHTEN,
244     CLP_PARAM_ACTION_FAKEBOUND,
245     CLP_PARAM_ACTION_HELP,
246     CLP_PARAM_ACTION_PLUSMINUS,
247     CLP_PARAM_ACTION_NETWORK,
248     CLP_PARAM_ACTION_ALLSLACK,
249     CLP_PARAM_ACTION_REVERSE,
250     CLP_PARAM_ACTION_BARRIER,
251     CLP_PARAM_ACTION_NETLIB_BARRIER,
252     CLP_PARAM_ACTION_NETLIB_TUNE,
253     CLP_PARAM_ACTION_REALLY_SCALE,
254     CLP_PARAM_ACTION_BASISIN,
255     CLP_PARAM_ACTION_BASISOUT,
256     CLP_PARAM_ACTION_SOLVECONTINUOUS,
257     CLP_PARAM_ACTION_CLEARCUTS,
258     CLP_PARAM_ACTION_VERSION,
259     CLP_PARAM_ACTION_STATISTICS,
260     CLP_PARAM_ACTION_DEBUG,
261     CLP_PARAM_ACTION_DUMMY,
262     CLP_PARAM_ACTION_PRINTMASK,
263     CLP_PARAM_ACTION_OUTDUPROWS,
264     CLP_PARAM_ACTION_USERCLP,
265     CLP_PARAM_ACTION_MODELIN,
266     CLP_PARAM_ACTION_CSVSTATISTICS,
267     CLP_PARAM_ACTION_STOREDFILE,
268     CLP_PARAM_ACTION_ENVIRONMENT,
269     CLP_PARAM_ACTION_PARAMETRICS,
270     CLP_PARAM_ACTION_GMPL_SOLUTION,
271
272     CBC_PARAM_ACTION_BAB = 351,
273     CBC_PARAM_ACTION_MIPLIB,
274     CBC_PARAM_ACTION_STRENGTHEN,
275     CBC_PARAM_ACTION_PRIORITYIN,
276     CBC_PARAM_ACTION_MIPSTART,
277     CBC_PARAM_ACTION_USERCBC,
278     CBC_PARAM_ACTION_DOHEURISTIC,
279     CLP_PARAM_ACTION_NEXTBESTSOLUTION,
280
281     CBC_PARAM_NOTUSED_OSLSTUFF = 401,
282     CBC_PARAM_NOTUSED_CBCSTUFF,
283
284     CBC_PARAM_NOTUSED_INVALID = 1000
285} ;
286#include <vector>
287#include <string>
288
289/// Very simple class for setting parameters
290
291class CbcOrClpParam {
292public:
293     /**@name Constructor and destructor */
294     //@{
295     /// Constructors
296     CbcOrClpParam (  );
297     CbcOrClpParam (std::string name, std::string help,
298                    double lower, double upper, CbcOrClpParameterType type, int display = 2);
299     CbcOrClpParam (std::string name, std::string help,
300                    int lower, int upper, CbcOrClpParameterType type, int display = 2);
301     // Other strings will be added by insert
302     CbcOrClpParam (std::string name, std::string help, std::string firstValue,
303                    CbcOrClpParameterType type, int whereUsed = 7, int display = 2);
304     // Action
305     CbcOrClpParam (std::string name, std::string help,
306                    CbcOrClpParameterType type, int whereUsed = 7, int display = 2);
307     /// Copy constructor.
308     CbcOrClpParam(const CbcOrClpParam &);
309     /// Assignment operator. This copies the data
310     CbcOrClpParam & operator=(const CbcOrClpParam & rhs);
311     /// Destructor
312     ~CbcOrClpParam (  );
313     //@}
314
315     /**@name stuff */
316     //@{
317     /// Insert string (only valid for keywords)
318     void append(std::string keyWord);
319     /// Adds one help line
320     void addHelp(std::string keyWord);
321     /// Returns name
322     inline std::string  name(  ) const {
323          return name_;
324     }
325     /// Returns short help
326     inline std::string  shortHelp(  ) const {
327          return shortHelp_;
328     }
329     /// Sets a double parameter (nonzero code if error)
330     int setDoubleParameter(CbcModel & model, double value) ;
331     /// Sets double parameter and returns printable string and error code
332     const char * setDoubleParameterWithMessage ( CbcModel & model, double  value , int & returnCode);
333     /// Gets a double parameter
334     double doubleParameter(CbcModel & model) const;
335     /// Sets a int parameter (nonzero code if error)
336     int setIntParameter(CbcModel & model, int value) ;
337     /// Sets int parameter and returns printable string and error code
338     const char * setIntParameterWithMessage ( CbcModel & model, int value , int & returnCode);
339     /// Gets a int parameter
340     int intParameter(CbcModel & model) const;
341     /// Sets a double parameter (nonzero code if error)
342     int setDoubleParameter(ClpSimplex * model, double value) ;
343     /// Gets a double parameter
344     double doubleParameter(ClpSimplex * model) const;
345     /// Sets double parameter and returns printable string and error code
346     const char * setDoubleParameterWithMessage ( ClpSimplex * model, double  value , int & returnCode);
347     /// Sets a int parameter (nonzero code if error)
348     int setIntParameter(ClpSimplex * model, int value) ;
349     /// Sets int parameter and returns printable string and error code
350     const char * setIntParameterWithMessage ( ClpSimplex * model, int  value , int & returnCode);
351     /// Gets a int parameter
352     int intParameter(ClpSimplex * model) const;
353     /// Sets a double parameter (nonzero code if error)
354     int setDoubleParameter(OsiSolverInterface * model, double value) ;
355     /// Sets double parameter and returns printable string and error code
356     const char * setDoubleParameterWithMessage ( OsiSolverInterface * model, double  value , int & returnCode);
357     /// Gets a double parameter
358     double doubleParameter(OsiSolverInterface * model) const;
359     /// Sets a int parameter (nonzero code if error)
360     int setIntParameter(OsiSolverInterface * model, int value) ;
361     /// Sets int parameter and returns printable string and error code
362     const char * setIntParameterWithMessage ( OsiSolverInterface * model, int  value , int & returnCode);
363     /// Gets a int parameter
364     int intParameter(OsiSolverInterface * model) const;
365     /// Checks a double parameter (nonzero code if error)
366     int checkDoubleParameter(double value) const;
367     /// Returns name which could match
368     std::string matchName (  ) const;
369     /// Returns length of name for ptinting
370     int lengthMatchName (  ) const;
371     /// Returns parameter option which matches (-1 if none)
372     int parameterOption ( std::string check ) const;
373     /// Prints parameter options
374     void printOptions (  ) const;
375     /// Returns current parameter option
376     inline std::string currentOption (  ) const {
377          return definedKeyWords_[currentKeyWord_];
378     }
379     /// Sets current parameter option
380     void setCurrentOption ( int value , bool printIt = false);
381     /// Sets current parameter option and returns printable string
382     const char * setCurrentOptionWithMessage ( int value );
383     /// Sets current parameter option using string
384     void setCurrentOption (const std::string value );
385     /// Returns current parameter option position
386     int currentOptionAsInteger (  ) const ;
387     /** Returns current parameter option position
388         but if fake keyword returns a fake value and sets
389         fakeInteger to true value.  If not fake then fakeInteger is -COIN_INT_MAX
390      */
391     int currentOptionAsInteger ( int & fakeInteger ) const;
392     /// Sets int value
393     void setIntValue ( int value );
394     inline int intValue () const {
395          return intValue_;
396     }
397     /// Sets double value
398     void setDoubleValue ( double value );
399     inline double doubleValue () const {
400          return doubleValue_;
401     }
402     /// Sets string value
403     void setStringValue ( std::string value );
404     inline std::string stringValue () const {
405          return stringValue_;
406     }
407     /// Returns 1 if matches minimum, 2 if matches less, 0 if not matched
408     int matches (std::string input) const;
409     /// type
410     inline CbcOrClpParameterType type() const {
411          return type_;
412     }
413     /// whether to display
414     inline int displayThis() const {
415          return display_;
416     }
417     /// Set Long help
418     inline void setLonghelp(const std::string help) {
419          longHelp_ = help;
420     }
421     /// Print Long help
422     void printLongHelp() const;
423     /// Print action and string
424     void printString() const;
425     /** 7 if used everywhere,
426         1 - used by clp
427         2 - used by cbc
428         4 - used by ampl
429     */
430     inline int whereUsed() const {
431          return whereUsed_;
432     }
433     /// Gets value of fake keyword
434     inline int fakeKeyWord() const
435     { return fakeKeyWord_;}
436     /// Sets value of fake keyword
437     inline void setFakeKeyWord(int value, int fakeValue)
438     { fakeKeyWord_ = value; fakeValue_ = fakeValue;}
439     /// Sets value of fake keyword to current size of keywords
440     void setFakeKeyWord(int fakeValue);
441
442private:
443     /// gutsOfConstructor
444     void gutsOfConstructor();
445     //@}
446////////////////// data //////////////////
447private:
448
449     /**@name data
450      We might as well throw all type data in - could derive?
451     */
452     //@{
453     // Type see CbcOrClpParameterType
454     CbcOrClpParameterType type_;
455     /// If double == okay
456     double lowerDoubleValue_;
457     double upperDoubleValue_;
458     /// If int == okay
459     int lowerIntValue_;
460     int upperIntValue_;
461     // Length of name
462     unsigned int lengthName_;
463     // Minimum match
464     unsigned int lengthMatch_;
465     /// set of valid strings
466     std::vector<std::string> definedKeyWords_;
467     /// Name
468     std::string name_;
469     /// Short help
470     std::string shortHelp_;
471     /// Long help
472     std::string longHelp_;
473     /// Action
474     CbcOrClpParameterType action_;
475     /// Current keyWord (if a keyword parameter)
476     int currentKeyWord_;
477     /// Display on ?
478     int display_;
479     /// Integer parameter - current value
480     int intValue_;
481     /// Double parameter - current value
482     double doubleValue_;
483     /// String parameter - current value
484     std::string stringValue_;
485     /** 7 if used everywhere,
486         1 - used by clp
487         2 - used by cbc
488         4 - used by ampl
489     */
490     int whereUsed_;
491     /** If >=0 then integers allowed as a fake keyword
492         So minusnnnn would got to -nnnn in currentKeyword_
493         and plusnnnn would go to fakeKeyword_+nnnn
494     */
495     int fakeKeyWord_;
496     /// Return this as main value if an integer
497     int fakeValue_;
498     //@}
499};
500/// Simple read stuff
501std::string CoinReadNextField();
502
503std::string CoinReadGetCommand(int argc, const char *argv[]);
504std::string CoinReadGetString(int argc, const char *argv[]);
505// valid 0 - okay, 1 bad, 2 not there
506int CoinReadGetIntField(int argc, const char *argv[], int * valid);
507double CoinReadGetDoubleField(int argc, const char *argv[], int * valid);
508void CoinReadPrintit(const char * input);
509void setCbcOrClpPrinting(bool yesNo);
510#define CBCMAXPARAMETERS 250
511/*
512  Subroutine to establish the cbc parameter array. See the description of
513  class CbcOrClpParam for details. Pulled from C..Main() for clarity.
514*/
515void establishParams (int &numberParameters, CbcOrClpParam *const parameters);
516// Given a parameter type - returns its number in list
517int whichParam (CbcOrClpParameterType name,
518                int numberParameters, CbcOrClpParam *const parameters);
519// Dump a solution to file
520void saveSolution(const ClpSimplex * lpSolver, std::string fileName);
521#endif  /* CbcOrClpParam_H */
Note: See TracBrowser for help on using the repository browser.