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

Last change on this file since 1904 was 1904, checked in by forrest, 8 years ago

for multiple root solvers

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 16.0 KB
Line 
1
2/* $Id: CbcOrClpParam.hpp 1904 2013-01-10 13:47:59Z 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
106     CBC_PARAM_INT_STRONGBRANCHING = 151,
107     CBC_PARAM_INT_CUTDEPTH,
108     CBC_PARAM_INT_MAXNODES,
109     CBC_PARAM_INT_NUMBERBEFORE,
110     CBC_PARAM_INT_NUMBERANALYZE,
111     CBC_PARAM_INT_MIPOPTIONS,
112     CBC_PARAM_INT_MOREMIPOPTIONS,
113     CBC_PARAM_INT_MAXHOTITS,
114     CBC_PARAM_INT_FPUMPITS,
115     CBC_PARAM_INT_MAXSOLS,
116     CBC_PARAM_INT_FPUMPTUNE,
117     CBC_PARAM_INT_TESTOSI,
118     CBC_PARAM_INT_EXTRA1,
119     CBC_PARAM_INT_EXTRA2,
120     CBC_PARAM_INT_EXTRA3,
121     CBC_PARAM_INT_EXTRA4,
122     CBC_PARAM_INT_DEPTHMINIBAB,
123     CBC_PARAM_INT_CUTPASSINTREE,
124     CBC_PARAM_INT_THREADS,
125     CBC_PARAM_INT_CUTPASS,
126     CBC_PARAM_INT_VUBTRY,
127     CBC_PARAM_INT_DENSE,
128     CBC_PARAM_INT_EXPERIMENT,
129     CBC_PARAM_INT_DIVEOPT,
130     CBC_PARAM_INT_STRATEGY,
131     CBC_PARAM_INT_SMALLFACT,
132     CBC_PARAM_INT_HOPTIONS,
133     CBC_PARAM_INT_CUTLENGTH,
134     CBC_PARAM_INT_FPUMPTUNE2,
135#ifdef COIN_HAS_CBC
136     CLP_PARAM_INT_LOGLEVEL ,
137#endif
138     CBC_PARAM_INT_MAXSAVEDSOLS,
139     CBC_PARAM_INT_RANDOMSEED,
140     CBC_PARAM_INT_MULTIPLEROOTS,
141
142     CLP_PARAM_STR_DIRECTION = 201,
143     CLP_PARAM_STR_DUALPIVOT,
144     CLP_PARAM_STR_SCALING,
145     CLP_PARAM_STR_ERRORSALLOWED,
146     CLP_PARAM_STR_KEEPNAMES,
147     CLP_PARAM_STR_SPARSEFACTOR,
148     CLP_PARAM_STR_PRIMALPIVOT,
149     CLP_PARAM_STR_PRESOLVE,
150     CLP_PARAM_STR_CRASH,
151     CLP_PARAM_STR_BIASLU,
152     CLP_PARAM_STR_PERTURBATION,
153     CLP_PARAM_STR_MESSAGES,
154     CLP_PARAM_STR_AUTOSCALE,
155     CLP_PARAM_STR_CHOLESKY,
156     CLP_PARAM_STR_KKT,
157     CLP_PARAM_STR_BARRIERSCALE,
158     CLP_PARAM_STR_GAMMA,
159     CLP_PARAM_STR_CROSSOVER,
160     CLP_PARAM_STR_PFI,
161     CLP_PARAM_STR_INTPRINT,
162     CLP_PARAM_STR_VECTOR,
163     CLP_PARAM_STR_FACTORIZATION,
164     CLP_PARAM_STR_ALLCOMMANDS,
165     CLP_PARAM_STR_TIME_MODE,
166     CLP_PARAM_STR_ABCWANTED,
167
168     CBC_PARAM_STR_NODESTRATEGY = 251,
169     CBC_PARAM_STR_BRANCHSTRATEGY,
170     CBC_PARAM_STR_CUTSSTRATEGY,
171     CBC_PARAM_STR_HEURISTICSTRATEGY,
172     CBC_PARAM_STR_GOMORYCUTS,
173     CBC_PARAM_STR_PROBINGCUTS,
174     CBC_PARAM_STR_KNAPSACKCUTS,
175     CBC_PARAM_STR_REDSPLITCUTS,
176     CBC_PARAM_STR_ROUNDING,
177     CBC_PARAM_STR_SOLVER,
178     CBC_PARAM_STR_CLIQUECUTS,
179     CBC_PARAM_STR_COSTSTRATEGY,
180     CBC_PARAM_STR_FLOWCUTS,
181     CBC_PARAM_STR_MIXEDCUTS,
182     CBC_PARAM_STR_TWOMIRCUTS,
183     CBC_PARAM_STR_PREPROCESS,
184     CBC_PARAM_STR_FPUMP,
185     CBC_PARAM_STR_GREEDY,
186     CBC_PARAM_STR_COMBINE,
187     CBC_PARAM_STR_PROXIMITY,
188     CBC_PARAM_STR_LOCALTREE,
189     CBC_PARAM_STR_SOS,
190     CBC_PARAM_STR_LANDPCUTS,
191     CBC_PARAM_STR_RINS,
192     CBC_PARAM_STR_RESIDCUTS,
193     CBC_PARAM_STR_RENS,
194     CBC_PARAM_STR_DIVINGS,
195     CBC_PARAM_STR_DIVINGC,
196     CBC_PARAM_STR_DIVINGF,
197     CBC_PARAM_STR_DIVINGG,
198     CBC_PARAM_STR_DIVINGL,
199     CBC_PARAM_STR_DIVINGP,
200     CBC_PARAM_STR_DIVINGV,
201     CBC_PARAM_STR_DINS,
202     CBC_PARAM_STR_PIVOTANDFIX,
203     CBC_PARAM_STR_RANDROUND,
204     CBC_PARAM_STR_NAIVE,
205     CBC_PARAM_STR_ZEROHALFCUTS,
206     CBC_PARAM_STR_CPX,
207     CBC_PARAM_STR_CROSSOVER2,
208     CBC_PARAM_STR_PIVOTANDCOMPLEMENT,
209     CBC_PARAM_STR_VND,
210     CBC_PARAM_STR_LAGOMORYCUTS,
211
212     CLP_PARAM_ACTION_DIRECTORY = 301,
213     CLP_PARAM_ACTION_DIRSAMPLE,
214     CLP_PARAM_ACTION_DIRNETLIB,
215     CBC_PARAM_ACTION_DIRMIPLIB,
216     CLP_PARAM_ACTION_IMPORT,
217     CLP_PARAM_ACTION_EXPORT,
218     CLP_PARAM_ACTION_RESTORE,
219     CLP_PARAM_ACTION_SAVE,
220     CLP_PARAM_ACTION_DUALSIMPLEX,
221     CLP_PARAM_ACTION_PRIMALSIMPLEX,
222     CLP_PARAM_ACTION_EITHERSIMPLEX,
223     CLP_PARAM_ACTION_MAXIMIZE,
224     CLP_PARAM_ACTION_MINIMIZE,
225     CLP_PARAM_ACTION_EXIT,
226     CLP_PARAM_ACTION_STDIN,
227     CLP_PARAM_ACTION_UNITTEST,
228     CLP_PARAM_ACTION_NETLIB_EITHER,
229     CLP_PARAM_ACTION_NETLIB_DUAL,
230     CLP_PARAM_ACTION_NETLIB_PRIMAL,
231     CLP_PARAM_ACTION_SOLUTION,
232     CLP_PARAM_ACTION_SAVESOL,
233     CLP_PARAM_ACTION_TIGHTEN,
234     CLP_PARAM_ACTION_FAKEBOUND,
235     CLP_PARAM_ACTION_HELP,
236     CLP_PARAM_ACTION_PLUSMINUS,
237     CLP_PARAM_ACTION_NETWORK,
238     CLP_PARAM_ACTION_ALLSLACK,
239     CLP_PARAM_ACTION_REVERSE,
240     CLP_PARAM_ACTION_BARRIER,
241     CLP_PARAM_ACTION_NETLIB_BARRIER,
242     CLP_PARAM_ACTION_NETLIB_TUNE,
243     CLP_PARAM_ACTION_REALLY_SCALE,
244     CLP_PARAM_ACTION_BASISIN,
245     CLP_PARAM_ACTION_BASISOUT,
246     CLP_PARAM_ACTION_SOLVECONTINUOUS,
247     CLP_PARAM_ACTION_CLEARCUTS,
248     CLP_PARAM_ACTION_VERSION,
249     CLP_PARAM_ACTION_STATISTICS,
250     CLP_PARAM_ACTION_DEBUG,
251     CLP_PARAM_ACTION_DUMMY,
252     CLP_PARAM_ACTION_PRINTMASK,
253     CLP_PARAM_ACTION_OUTDUPROWS,
254     CLP_PARAM_ACTION_USERCLP,
255     CLP_PARAM_ACTION_MODELIN,
256     CLP_PARAM_ACTION_CSVSTATISTICS,
257     CLP_PARAM_ACTION_STOREDFILE,
258     CLP_PARAM_ACTION_ENVIRONMENT,
259     CLP_PARAM_ACTION_PARAMETRICS,
260     CLP_PARAM_ACTION_GMPL_SOLUTION,
261
262     CBC_PARAM_ACTION_BAB = 351,
263     CBC_PARAM_ACTION_MIPLIB,
264     CBC_PARAM_ACTION_STRENGTHEN,
265     CBC_PARAM_ACTION_PRIORITYIN,
266     CBC_PARAM_ACTION_MIPSTART,
267     CBC_PARAM_ACTION_USERCBC,
268     CBC_PARAM_ACTION_DOHEURISTIC,
269     CLP_PARAM_ACTION_NEXTBESTSOLUTION,
270
271     CBC_PARAM_NOTUSED_OSLSTUFF = 401,
272     CBC_PARAM_NOTUSED_CBCSTUFF,
273
274     CBC_PARAM_NOTUSED_INVALID = 1000
275} ;
276#include <vector>
277#include <string>
278
279/// Very simple class for setting parameters
280
281class CbcOrClpParam {
282public:
283     /**@name Constructor and destructor */
284     //@{
285     /// Constructors
286     CbcOrClpParam (  );
287     CbcOrClpParam (std::string name, std::string help,
288                    double lower, double upper, CbcOrClpParameterType type, int display = 2);
289     CbcOrClpParam (std::string name, std::string help,
290                    int lower, int upper, CbcOrClpParameterType type, int display = 2);
291     // Other strings will be added by insert
292     CbcOrClpParam (std::string name, std::string help, std::string firstValue,
293                    CbcOrClpParameterType type, int whereUsed = 7, int display = 2);
294     // Action
295     CbcOrClpParam (std::string name, std::string help,
296                    CbcOrClpParameterType type, int whereUsed = 7, int display = 2);
297     /// Copy constructor.
298     CbcOrClpParam(const CbcOrClpParam &);
299     /// Assignment operator. This copies the data
300     CbcOrClpParam & operator=(const CbcOrClpParam & rhs);
301     /// Destructor
302     ~CbcOrClpParam (  );
303     //@}
304
305     /**@name stuff */
306     //@{
307     /// Insert string (only valid for keywords)
308     void append(std::string keyWord);
309     /// Adds one help line
310     void addHelp(std::string keyWord);
311     /// Returns name
312     inline std::string  name(  ) const {
313          return name_;
314     }
315     /// Returns short help
316     inline std::string  shortHelp(  ) const {
317          return shortHelp_;
318     }
319     /// Sets a double parameter (nonzero code if error)
320     int setDoubleParameter(CbcModel & model, double value) ;
321     /// Sets double parameter and returns printable string and error code
322     const char * setDoubleParameterWithMessage ( CbcModel & model, double  value , int & returnCode);
323     /// Gets a double parameter
324     double doubleParameter(CbcModel & model) const;
325     /// Sets a int parameter (nonzero code if error)
326     int setIntParameter(CbcModel & model, int value) ;
327     /// Sets int parameter and returns printable string and error code
328     const char * setIntParameterWithMessage ( CbcModel & model, int value , int & returnCode);
329     /// Gets a int parameter
330     int intParameter(CbcModel & model) const;
331     /// Sets a double parameter (nonzero code if error)
332     int setDoubleParameter(ClpSimplex * model, double value) ;
333     /// Gets a double parameter
334     double doubleParameter(ClpSimplex * model) const;
335     /// Sets double parameter and returns printable string and error code
336     const char * setDoubleParameterWithMessage ( ClpSimplex * model, double  value , int & returnCode);
337     /// Sets a int parameter (nonzero code if error)
338     int setIntParameter(ClpSimplex * model, int value) ;
339     /// Sets int parameter and returns printable string and error code
340     const char * setIntParameterWithMessage ( ClpSimplex * model, int  value , int & returnCode);
341     /// Gets a int parameter
342     int intParameter(ClpSimplex * model) const;
343     /// Sets a double parameter (nonzero code if error)
344     int setDoubleParameter(OsiSolverInterface * model, double value) ;
345     /// Sets double parameter and returns printable string and error code
346     const char * setDoubleParameterWithMessage ( OsiSolverInterface * model, double  value , int & returnCode);
347     /// Gets a double parameter
348     double doubleParameter(OsiSolverInterface * model) const;
349     /// Sets a int parameter (nonzero code if error)
350     int setIntParameter(OsiSolverInterface * model, int value) ;
351     /// Sets int parameter and returns printable string and error code
352     const char * setIntParameterWithMessage ( OsiSolverInterface * model, int  value , int & returnCode);
353     /// Gets a int parameter
354     int intParameter(OsiSolverInterface * model) const;
355     /// Checks a double parameter (nonzero code if error)
356     int checkDoubleParameter(double value) const;
357     /// Returns name which could match
358     std::string matchName (  ) const;
359     /// Returns length of name for ptinting
360     int lengthMatchName (  ) const;
361     /// Returns parameter option which matches (-1 if none)
362     int parameterOption ( std::string check ) const;
363     /// Prints parameter options
364     void printOptions (  ) const;
365     /// Returns current parameter option
366     inline std::string currentOption (  ) const {
367          return definedKeyWords_[currentKeyWord_];
368     }
369     /// Sets current parameter option
370     void setCurrentOption ( int value , bool printIt = false);
371     /// Sets current parameter option and returns printable string
372     const char * setCurrentOptionWithMessage ( int value );
373     /// Sets current parameter option using string
374     void setCurrentOption (const std::string value );
375     /// Returns current parameter option position
376     inline int currentOptionAsInteger (  ) const {
377          return currentKeyWord_;
378     }
379     /// Sets int value
380     void setIntValue ( int value );
381     inline int intValue () const {
382          return intValue_;
383     }
384     /// Sets double value
385     void setDoubleValue ( double value );
386     inline double doubleValue () const {
387          return doubleValue_;
388     }
389     /// Sets string value
390     void setStringValue ( std::string value );
391     inline std::string stringValue () const {
392          return stringValue_;
393     }
394     /// Returns 1 if matches minimum, 2 if matches less, 0 if not matched
395     int matches (std::string input) const;
396     /// type
397     inline CbcOrClpParameterType type() const {
398          return type_;
399     }
400     /// whether to display
401     inline int displayThis() const {
402          return display_;
403     }
404     /// Set Long help
405     inline void setLonghelp(const std::string help) {
406          longHelp_ = help;
407     }
408     /// Print Long help
409     void printLongHelp() const;
410     /// Print action and string
411     void printString() const;
412     /** 7 if used everywhere,
413         1 - used by clp
414         2 - used by cbc
415         4 - used by ampl
416     */
417     inline int whereUsed() const {
418          return whereUsed_;
419     }
420
421private:
422     /// gutsOfConstructor
423     void gutsOfConstructor();
424     //@}
425////////////////// data //////////////////
426private:
427
428     /**@name data
429      We might as well throw all type data in - could derive?
430     */
431     //@{
432     // Type see CbcOrClpParameterType
433     CbcOrClpParameterType type_;
434     /// If double == okay
435     double lowerDoubleValue_;
436     double upperDoubleValue_;
437     /// If int == okay
438     int lowerIntValue_;
439     int upperIntValue_;
440     // Length of name
441     unsigned int lengthName_;
442     // Minimum match
443     unsigned int lengthMatch_;
444     /// set of valid strings
445     std::vector<std::string> definedKeyWords_;
446     /// Name
447     std::string name_;
448     /// Short help
449     std::string shortHelp_;
450     /// Long help
451     std::string longHelp_;
452     /// Action
453     CbcOrClpParameterType action_;
454     /// Current keyWord (if a keyword parameter)
455     int currentKeyWord_;
456     /// Display on ?
457     int display_;
458     /// Integer parameter - current value
459     int intValue_;
460     /// Double parameter - current value
461     double doubleValue_;
462     /// String parameter - current value
463     std::string stringValue_;
464     /** 7 if used everywhere,
465         1 - used by clp
466         2 - used by cbc
467         4 - used by ampl
468     */
469     int whereUsed_;
470     //@}
471};
472/// Simple read stuff
473std::string CoinReadNextField();
474
475std::string CoinReadGetCommand(int argc, const char *argv[]);
476std::string CoinReadGetString(int argc, const char *argv[]);
477// valid 0 - okay, 1 bad, 2 not there
478int CoinReadGetIntField(int argc, const char *argv[], int * valid);
479double CoinReadGetDoubleField(int argc, const char *argv[], int * valid);
480void CoinReadPrintit(const char * input);
481void setCbcOrClpPrinting(bool yesNo);
482#define CBCMAXPARAMETERS 250
483/*
484  Subroutine to establish the cbc parameter array. See the description of
485  class CbcOrClpParam for details. Pulled from C..Main() for clarity.
486*/
487void establishParams (int &numberParameters, CbcOrClpParam *const parameters);
488// Given a parameter type - returns its number in list
489int whichParam (CbcOrClpParameterType name,
490                int numberParameters, CbcOrClpParam *const parameters);
491// Dump a solution to file
492void saveSolution(const ClpSimplex * lpSolver, std::string fileName);
493#endif  /* CbcOrClpParam_H */
Note: See TracBrowser for help on using the repository browser.