File: CbcGenParam.hpp

package info (click to toggle)
coinor-cbc 2.9.9+repack1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 7,848 kB
  • ctags: 5,787
  • sloc: cpp: 104,337; sh: 8,921; xml: 2,950; makefile: 520; ansic: 491; awk: 197
file content (224 lines) | stat: -rw-r--r-- 6,417 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/*
  Copyright (C) 2007, Lou Hafer, International Business Machines Corporation
  and others.  All Rights Reserved.

  This code is licensed under the terms of the Eclipse Public License (EPL).

  $Id: CbcGenParam.hpp 1899 2013-04-09 18:12:08Z stefan $
*/
/*
  This file is part of cbc-generic.
*/

#ifndef CbcGenParam_H
#define CbcGenParam_H

/* \file CbcGenParam.hpp
   \brief Declarations for parameters that control the cbc-generic main
	  program.
*/

/*
  $Id: CbcGenParam.hpp 1899 2013-04-09 18:12:08Z stefan $
*/

class CbcGenCtlBlk ;

/*! \class CbcGenParam
    \brief Class for cbc-generic control parameters

    Adds parameter type codes and push/pull functions to the generic parameter
    object.
*/

class CbcGenParam : public CoinParam {

public:

    /*! \name Subtypes */
//@{

    /*! \enum CbcGenParamCode
        \brief Enumeration for cbc-generic parameters

      These are parameters that control the operation of the cbc-generic main
      program by operating on a CbcGenCtlBlk object. CBCGEN_FIRSTPARAM and
      CBCGEN_LASTPARM are markers to allow convenient separation of parameter
      groups.
    */
    typedef enum { CBCGEN_FIRSTPARAM = 0,

                   GENERALQUERY, FULLGENERALQUERY, HELP,
                   BAB, CLEARCUTS, CLIQUECUTS, COMBINE, COSTSTRATEGY,
                   CPP, CUTDEPTH, CUTSTRATEGY,
                   DEBUG, DIRECTORY, DJFIX, DUMMY,
                   ERRORSALLOWED, EXIT, EXPORT,
                   FLOWCUTS, FPUMP, FPUMPITS, GOMORYCUTS, GREEDY, HEURISTICSTRATEGY,
                   IMPORT, INTPRINT, KNAPSACKCUTS, LOCALTREE, LOGLEVEL,
                   MESSAGES, MIPLIB, MIXEDCUTS, ODDHOLECUTS, OUTDUPROWS, OUTPUTFORMAT,
                   PREPROCESS, PRINTMASK, PRINTOPTIONS, PRINTVERSION, PRIORITYIN, PROBINGCUTS,
                   REDSPLITCUTS, ROUNDING,
                   SOLUTION, SOLVECONTINUOUS, SOLVER, SOS, STDIN, STRENGTHEN,
                   TIGHTENFACTOR, TWOMIRCUTS,
                   UNITTEST, USERCBC, USESOLUTION, VERBOSE, SHOWUNIMP,

                   CBCGEN_LASTPARAM

                 } CbcGenParamCode ;

//@}

    /*! \name Constructors and Destructors

      Be careful how you specify parameters for the constructors! There's great
      potential for confusion.
    */
//@{
    /*! \brief Default constructor */

    CbcGenParam() ;

    /*! \brief Constructor for a parameter with a double value

      The default value is 0.0. Be careful to clearly indicate that \p lower and
      \p upper are real (double) values to distinguish this constructor from the
      constructor for an integer parameter.
    */
    CbcGenParam(CbcGenParamCode code, std::string name, std::string help,
                double lower, double upper, double dflt = 0.0,
                bool display = true) ;

    /*! \brief Constructor for a parameter with an integer value

      The default value is 0.
    */
    CbcGenParam(CbcGenParamCode code, std::string name, std::string help,
                int lower, int upper, int dflt = 0,
                bool display = true) ;

    /*! \brief Constructor for a parameter with keyword values

      The string supplied as \p firstValue becomes the first keyword.
      Additional keywords can be added using appendKwd(). Keywords are numbered
      from zero. It's necessary to specify both the first keyword (\p
      firstValue) and the default keyword index (\p dflt) in order to
      distinguish this constructor from the string and action parameter
      constructors.
    */
    CbcGenParam(CbcGenParamCode code, std::string name, std::string help,
                std::string firstValue, int dflt, bool display = true) ;

    /*! \brief Constructor for a string parameter

      The default string value must be specified explicitly to distinguish
      a string constructor from an action parameter constructor.
    */

    CbcGenParam(CbcGenParamCode code, std::string name, std::string help,
                std::string dflt, bool display = true) ;

    /*! \brief Constructor for an action parameter */

    CbcGenParam(CbcGenParamCode code, std::string name, std::string help,
                bool display = true) ;

    /*! \brief Copy constructor */

    CbcGenParam(const CbcGenParam &orig) ;

    /*! \brief Clone */

    CbcGenParam *clone() ;

    /*! \brief Assignment */

    CbcGenParam &operator=(const CbcGenParam &rhs) ;

    /*! \brief  Destructor */

    ~CbcGenParam() ;

//@}

    /*! \name Methods to query and manipulate a parameter object */
//@{

    /*! \brief Get the parameter code  */

    inline CbcGenParamCode paramCode() const {
        return (paramCode_) ;
    }

    /*! \brief Set the parameter code */

    inline void setParamCode(CbcGenParamCode code) {
        paramCode_ = code ;
    }

    /*! \brief Get the underlying cbc-generic control object */

    inline CbcGenCtlBlk *obj() const {
        return (obj_) ;
    }

    /*! \brief Set the underlying cbc-generic control object */

    inline void setObj(CbcGenCtlBlk *obj) {
        obj_ = obj ;
    }

//@}


private:

    /*! \name Data */
//@{

    /// Parameter code
    CbcGenParamCode paramCode_ ;

    /// cbc-generic control object
    CbcGenCtlBlk *obj_ ;

//@}

} ;

/*
  Declare the utility functions.
*/

namespace CbcGenParamUtils {
void addCbcGenParams(int &numParams, CoinParamVec &paramVec,
                     CbcGenCtlBlk *ctlBlk) ;
void loadGenParamObj(const CoinParamVec paramVec, int first, int last,
                     CbcGenCtlBlk *ctlBlk) ;

void saveSolution(const OsiSolverInterface *osi, std::string fileName) ;
bool readSolution(std::string fileName,
                  int &numRows, int &numCols, double &objVal,
                  double **rowActivity, double **dualVars,
                  double **primalVars, double **reducedCosts) ;

int doBaCParam(CoinParam *param) ;
int doDebugParam(CoinParam *param) ;
int doExitParam(CoinParam *param) ;
int doHelpParam(CoinParam *param) ;
int doImportParam(CoinParam *param) ;
int doPrintMaskParam(CoinParam *param) ;
int doNothingParam(CoinParam *param) ;
int doSolutionParam(CoinParam *param) ;
int doUnimplementedParam(CoinParam *param) ;
int doVersionParam(CoinParam *param) ;

int pushCbcGenDblParam(CoinParam *param) ;
int pushCbcGenIntParam(CoinParam *param) ;
int pushCbcGenKwdParam(CoinParam *param) ;
int pushCbcGenStrParam(CoinParam *param) ;

int pushCbcGenCutParam(CoinParam *param) ;
}


#endif