Cbc  2.9.9
CbcGenCbcParam.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2007, Lou Hafer, International Business Machines Corporation
3  and others. All Rights Reserved.
4 
5  This code is licensed under the terms of the Eclipse Public License (EPL).
6 
7  $Id: CbcGenCbcParam.hpp 1899 2013-04-09 18:12:08Z stefan $
8 */
9 /*
10  This file is part of cbc-generic.
11 */
12 
13 #ifndef CbcCbcParam_H
14 #define CbcCbcParam_H
15 
16 /* \file CbcGenCbcParam.hpp
17  \brief Declarations for parameters that act on a CbcModel object.
18 */
19 
20 /*
21  $Id: CbcGenCbcParam.hpp 1899 2013-04-09 18:12:08Z stefan $
22 */
23 
31 class CbcCbcParam : public CoinParam {
32 
33 public:
34 
37 
46 
55 
57 
59 
61 
71 
78  CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help,
79  double lower, double upper, double dflt = 0.0,
80  bool display = true) ;
81 
86  CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help,
87  int lower, int upper, int dflt = 0,
88  bool display = true) ;
89 
99  CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help,
100  std::string firstValue, int dflt, bool display = true) ;
101 
108  CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help,
109  std::string dflt, bool display = true) ;
110 
113  CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help,
114  bool display = true) ;
115 
118  CbcCbcParam(const CbcCbcParam &orig) ;
119 
123 
127 
131 
133 
136 
139  inline CbcCbcParamCode paramCode() const {
140  return (paramCode_) ;
141  }
142 
145  inline void setParamCode(CbcCbcParamCode code) {
146  paramCode_ = code ;
147  }
148 
151  inline CbcModel *obj() const {
152  return (obj_) ;
153  }
154 
157  inline void setObj(CbcModel *obj) {
158  obj_ = obj ;
159  }
160 
162 
163 private:
164 
167 
169  CbcCbcParamCode paramCode_ ;
170 
172  CbcModel *obj_ ;
173 
175 
176 } ;
177 
178 
179 /*
180  Declare the utility functions.
181 */
182 
183 namespace CbcCbcParamUtils {
184 void addCbcCbcParams(int &numParams, CoinParamVec &paramVec,
185  CbcModel *model) ;
186 void loadCbcParamObj(const CoinParamVec paramVec, int first, int last,
187  CbcModel *model) ;
189 
190 int pushCbcCbcDbl(CoinParam *param) ;
191 int pushCbcCbcInt(CoinParam *param) ;
192 }
193 
194 #endif
195 
CbcCbcParam::CbcCbcParam
CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help, int lower, int upper, int dflt=0, bool display=true)
Constructor for a parameter with an integer value.
CbcCbcParam::CbcCbcParam
CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help, double lower, double upper, double dflt=0.0, bool display=true)
Constructor for a parameter with a double value.
CbcCbcParam::CUTOFF
@ CUTOFF
Definition: CbcGenCbcParam.hpp:48
CbcGenParam::CBCGEN_LASTPARAM
@ CBCGEN_LASTPARAM
Definition: CbcGenParam.hpp:65
CbcCbcParam::MOREMIPOPTIONS
@ MOREMIPOPTIONS
Definition: CbcGenCbcParam.hpp:52
CbcCbcParam::CbcCbcParam
CbcCbcParam(const CbcCbcParam &orig)
Copy constructor.
CbcCbcParam::CbcCbcParam
CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help, std::string dflt, bool display=true)
Constructor for a string parameter.
CbcCbcParam
Class for control parameters that act on a CbcModel object.
Definition: CbcGenCbcParam.hpp:31
CbcCbcParam::operator=
CbcCbcParam & operator=(const CbcCbcParam &rhs)
Assignment.
CbcCbcParam::CBCCBC_LASTPARAM
@ CBCCBC_LASTPARAM
Definition: CbcGenCbcParam.hpp:56
CbcCbcParamUtils::loadCbcParamObj
void loadCbcParamObj(const CoinParamVec paramVec, int first, int last, CbcModel *model)
CbcCbcParam::CUTPASS
@ CUTPASS
Definition: CbcGenCbcParam.hpp:48
CbcCbcParam::MAXIMIZE
@ MAXIMIZE
Definition: CbcGenCbcParam.hpp:51
CbcCbcParam::CUTDEPTH
@ CUTDEPTH
Definition: CbcGenCbcParam.hpp:48
CbcCbcParam::MAXNODES
@ MAXNODES
Definition: CbcGenCbcParam.hpp:51
CbcCbcParamUtils::pushCbcCbcDbl
int pushCbcCbcDbl(CoinParam *param)
CbcCbcParam::MINIMIZE
@ MINIMIZE
Definition: CbcGenCbcParam.hpp:51
CbcCbcParam::NUMBERMINI
@ NUMBERMINI
Definition: CbcGenCbcParam.hpp:53
CbcCbcParam::CbcCbcParam
CbcCbcParam()
Default constructor.
CbcCbcParam::MIPOPTIONS
@ MIPOPTIONS
Definition: CbcGenCbcParam.hpp:52
CbcCbcParam::GAPRATIO
@ GAPRATIO
Definition: CbcGenCbcParam.hpp:49
CbcCbcParam::STRONGBRANCHING
@ STRONGBRANCHING
Definition: CbcGenCbcParam.hpp:54
CbcCbcParam::obj
CbcModel * obj() const
Get the underlying CbcModel object.
Definition: CbcGenCbcParam.hpp:151
CbcModel
Simple Branch and bound class.
Definition: CbcModel.hpp:101
CbcCbcParam::NUMBERBEFORE
@ NUMBERBEFORE
Definition: CbcGenCbcParam.hpp:53
CbcCbcParamUtils::setCbcModelDefaults
void setCbcModelDefaults(CbcModel *model)
CbcCbcParamUtils::pushCbcCbcInt
int pushCbcCbcInt(CoinParam *param)
CbcCbcParam::NUMBERANALYZE
@ NUMBERANALYZE
Definition: CbcGenCbcParam.hpp:52
CbcCbcParam::setParamCode
void setParamCode(CbcCbcParamCode code)
Set the parameter code.
Definition: CbcGenCbcParam.hpp:145
CbcCbcParam::DIRECTION
@ DIRECTION
Definition: CbcGenCbcParam.hpp:48
CbcCbcParam::setObj
void setObj(CbcModel *obj)
Set the underlying CbcModel object.
Definition: CbcGenCbcParam.hpp:157
CbcCbcParam::~CbcCbcParam
~CbcCbcParam()
Destructor.
CbcCbcParam::CbcCbcParam
CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help, std::string firstValue, int dflt, bool display=true)
Constructor for a parameter with keyword values.
CbcCbcParam::clone
CbcCbcParam * clone()
Clone.
CbcCbcParam::LOGLEVEL
@ LOGLEVEL
Definition: CbcGenCbcParam.hpp:51
CbcCbcParam::CbcCbcParamCode
CbcCbcParamCode
Enumeration for parameters that control a CbcModel object.
Definition: CbcGenCbcParam.hpp:45
CbcCbcParam::TIMELIMIT_BAB
@ TIMELIMIT_BAB
Definition: CbcGenCbcParam.hpp:54
CbcCbcParam::INCREMENT
@ INCREMENT
Definition: CbcGenCbcParam.hpp:50
CbcCbcParam::INTEGERTOLERANCE
@ INTEGERTOLERANCE
Definition: CbcGenCbcParam.hpp:50
CbcCbcParamUtils
Definition: CbcGenCbcParam.hpp:183
CbcCbcParam::INFEASIBILITYWEIGHT
@ INFEASIBILITYWEIGHT
Definition: CbcGenCbcParam.hpp:50
CbcCbcParam::ALLOWABLEGAP
@ ALLOWABLEGAP
Definition: CbcGenCbcParam.hpp:47
CbcCbcParam::CBCCBC_FIRSTPARAM
@ CBCCBC_FIRSTPARAM
Definition: CbcGenCbcParam.hpp:45
CbcCbcParam::COSTSTRATEGY
@ COSTSTRATEGY
Definition: CbcGenCbcParam.hpp:47
CbcCbcParam::paramCode
CbcCbcParamCode paramCode() const
Get the parameter code
Definition: CbcGenCbcParam.hpp:139
CbcCbcParam::CbcCbcParam
CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help, bool display=true)
Constructor for an action parameter.
CbcCbcParamUtils::addCbcCbcParams
void addCbcCbcParams(int &numParams, CoinParamVec &paramVec, CbcModel *model)