Cbc
2.10.3
|
Class for control parameters that act on a CbcModel object. More...
#include <CbcGenCbcParam.hpp>
Public Types | |
Subtypes | |
enum | CbcCbcParamCode { CBCCBC_FIRSTPARAM = CbcGenParam::CBCGEN_LASTPARAM + 1, ALLOWABLEGAP, COSTSTRATEGY, CUTDEPTH, CUTOFF, CUTPASS, DIRECTION, GAPRATIO, INCREMENT, INFEASIBILITYWEIGHT, INTEGERTOLERANCE, LOGLEVEL, MAXIMIZE, MAXNODES, MINIMIZE, MIPOPTIONS, MOREMIPOPTIONS, NUMBERANALYZE, NUMBERBEFORE, NUMBERMINI, STRONGBRANCHING, TIMELIMIT_BAB, CBCCBC_LASTPARAM } |
Enumeration for parameters that control a CbcModel object. More... | |
![]() | |
enum | CoinParamType |
enum | CoinParamType |
typedef int(* | CoinParamFunc) (CoinParam *param) |
typedef std::vector< CoinParam * > | CoinParamVec |
typedef int(* | CoinParamFunc) (CoinParam *param) |
Public Member Functions | |
Constructors and Destructors | |
Be careful how you specify parameters for the constructors! There's great potential for confusion. | |
CbcCbcParam () | |
Default constructor. More... | |
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. More... | |
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. More... | |
CbcCbcParam (CbcCbcParamCode code, std::string name, std::string help, std::string firstValue, int dflt, bool display=true) | |
Constructor for a parameter with keyword values. More... | |
CbcCbcParam (CbcCbcParamCode code, std::string name, std::string help, std::string dflt, bool display=true) | |
Constructor for a string parameter. More... | |
CbcCbcParam (CbcCbcParamCode code, std::string name, std::string help, bool display=true) | |
Constructor for an action parameter. More... | |
CbcCbcParam (const CbcCbcParam &orig) | |
Copy constructor. More... | |
CbcCbcParam * | clone () |
Clone. More... | |
CbcCbcParam & | operator= (const CbcCbcParam &rhs) |
Assignment. More... | |
~CbcCbcParam () | |
Destructor. More... | |
Methods to query and manipulate a parameter object | |
CbcCbcParamCode | paramCode () const |
Get the parameter code. More... | |
void | setParamCode (CbcCbcParamCode code) |
Set the parameter code. More... | |
CbcModel * | obj () const |
Get the underlying CbcModel object. More... | |
void | setObj (CbcModel *obj) |
Set the underlying CbcModel object. More... | |
![]() | |
CoinParam () | |
CoinParam (std::string name, std::string help, double lower, double upper, double dflt=0.0, bool display=true) | |
CoinParam (std::string name, std::string help, int lower, int upper, int dflt=0, bool display=true) | |
CoinParam (std::string name, std::string help, std::string firstValue, int dflt, bool display=true) | |
CoinParam (std::string name, std::string help, std::string dflt, bool display=true) | |
CoinParam (std::string name, std::string help, bool display=true) | |
CoinParam (const CoinParam &orig) | |
CoinParam & | operator= (const CoinParam &rhs) |
virtual | ~CoinParam () |
void | appendKwd (std::string kwd) |
int | kwdIndex (std::string kwd) const |
std::string | kwdVal () const |
void | setKwdVal (int value, bool printIt=false) |
void | setKwdVal (const std::string value) |
void | printKwds () const |
void | setStrVal (std::string value) |
std::string | strVal () const |
void | setDblVal (double value) |
double | dblVal () const |
void | setIntVal (int value) |
int | intVal () const |
void | setShortHelp (const std::string help) |
std::string | shortHelp () const |
void | setLongHelp (const std::string help) |
std::string | longHelp () const |
void | printLongHelp () const |
CoinParamType | type () const |
void | setType (CoinParamType type) |
std::string | name () const |
void | setName (std::string name) |
int | matches (std::string input) const |
std::string | matchName () const |
void | setDisplay (bool display) |
bool | display () const |
CoinParamFunc | pushFunc () |
void | setPushFunc (CoinParamFunc func) |
CoinParamFunc | pullFunc () |
void | setPullFunc (CoinParamFunc func) |
std::ostream & | operator<< (std::ostream &s, const CoinParam ¶m) |
void | setInputSrc (FILE *src) |
bool | isCommandLine () |
bool | isInteractive () |
std::string | getStringField (int argc, const char *argv[], int *valid) |
int | getIntField (int argc, const char *argv[], int *valid) |
double | getDoubleField (int argc, const char *argv[], int *valid) |
int | matchParam (const CoinParamVec ¶mVec, std::string name, int &matchNdx, int &shortCnt) |
std::string | getCommand (int argc, const char *argv[], const std::string prompt, std::string *pfx=0) |
int | lookupParam (std::string name, CoinParamVec ¶mVec, int *matchCnt=0, int *shortCnt=0, int *queryCnt=0) |
void | printIt (const char *msg) |
void | shortOrHelpOne (CoinParamVec ¶mVec, int matchNdx, std::string name, int numQuery) |
void | shortOrHelpMany (CoinParamVec ¶mVec, std::string name, int numQuery) |
void | printGenericHelp () |
void | printHelp (CoinParamVec ¶mVec, int firstParam, int lastParam, std::string prefix, bool shortHelp, bool longHelp, bool hidden) |
CoinParam () | |
CoinParam (std::string name, std::string help, double lower, double upper, double dflt=0.0, bool display=true) | |
CoinParam (std::string name, std::string help, int lower, int upper, int dflt=0, bool display=true) | |
CoinParam (std::string name, std::string help, std::string firstValue, int dflt, bool display=true) | |
CoinParam (std::string name, std::string help, std::string dflt, bool display=true) | |
CoinParam (std::string name, std::string help, bool display=true) | |
CoinParam (const CoinParam &orig) | |
CoinParam & | operator= (const CoinParam &rhs) |
virtual | ~CoinParam () |
void | appendKwd (std::string kwd) |
int | kwdIndex (std::string kwd) const |
std::string | kwdVal () const |
void | setKwdVal (int value, bool printIt=false) |
void | setKwdVal (const std::string value) |
void | printKwds () const |
void | setStrVal (std::string value) |
std::string | strVal () const |
void | setDblVal (double value) |
double | dblVal () const |
void | setIntVal (int value) |
int | intVal () const |
void | setShortHelp (const std::string help) |
std::string | shortHelp () const |
void | setLongHelp (const std::string help) |
std::string | longHelp () const |
void | printLongHelp () const |
CoinParamType | type () const |
void | setType (CoinParamType type) |
std::string | name () const |
void | setName (std::string name) |
int | matches (std::string input) const |
std::string | matchName () const |
void | setDisplay (bool display) |
bool | display () const |
CoinParamFunc | pushFunc () |
void | setPushFunc (CoinParamFunc func) |
CoinParamFunc | pullFunc () |
void | setPullFunc (CoinParamFunc func) |
Additional Inherited Members | |
![]() | |
coinParamInvalid | |
coinParamAct | |
coinParamInt | |
coinParamDbl | |
coinParamStr | |
coinParamKwd | |
Class for control parameters that act on a CbcModel object.
Adds parameter type codes and push/pull functions to the generic parameter object.
Definition at line 31 of file CbcGenCbcParam.hpp.
Enumeration for parameters that control a CbcModel object.
These are parameters that control the operation of a CbcModel object. CBCCBC_FIRSTPARAM and CBCCBC_LASTPARAM are markers to allow convenient separation of parameter groups.
Definition at line 44 of file CbcGenCbcParam.hpp.
CbcCbcParam::CbcCbcParam | ( | ) |
Default constructor.
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.
The default value is 0.0. Be careful to clearly indicate that lower
and upper
are real (double) values to distinguish this constructor from the constructor for an integer parameter.
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.
The default value is 0.
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.
The string supplied as 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 (firstValue
) and the default keyword index (dflt
) in order to distinguish this constructor from the string and action parameter constructors.
CbcCbcParam::CbcCbcParam | ( | CbcCbcParamCode | code, |
std::string | name, | ||
std::string | help, | ||
std::string | dflt, | ||
bool | display = true |
||
) |
Constructor for a string parameter.
The default string value must be specified explicitly to distinguish a string constructor from an action parameter constructor.
CbcCbcParam::CbcCbcParam | ( | CbcCbcParamCode | code, |
std::string | name, | ||
std::string | help, | ||
bool | display = true |
||
) |
Constructor for an action parameter.
CbcCbcParam::CbcCbcParam | ( | const CbcCbcParam & | orig | ) |
Copy constructor.
CbcCbcParam::~CbcCbcParam | ( | ) |
Destructor.
|
virtual |
Clone.
Reimplemented from CoinParam.
CbcCbcParam& CbcCbcParam::operator= | ( | const CbcCbcParam & | rhs | ) |
Assignment.
|
inline |
Get the parameter code.
Definition at line 151 of file CbcGenCbcParam.hpp.
|
inline |
Set the parameter code.
Definition at line 158 of file CbcGenCbcParam.hpp.
|
inline |
Get the underlying CbcModel object.
Definition at line 165 of file CbcGenCbcParam.hpp.
|
inline |
Set the underlying CbcModel object.
Definition at line 172 of file CbcGenCbcParam.hpp.