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

Last change on this file since 1850 was 1850, checked in by stefan, 10 years ago

merge chgset 1849 from stable/1.14

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