Cbc  2.9.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
CbcGenParam Class Reference

Class for cbc-generic control parameters. More...

#include <CbcGenParam.hpp>

+ Inheritance diagram for CbcGenParam:
+ Collaboration diagram for CbcGenParam:

Public Types

Subtypes
enum  CbcGenParamCode {
  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
}
 Enumeration for cbc-generic parameters. More...
 
- Public Types inherited from CoinParam
enum  CoinParamType {
  coinParamInvalid = 0, coinParamAct, coinParamInt, coinParamDbl,
  coinParamStr, coinParamKwd
}
 Enumeration for the types of parameters supported by CoinParam. More...
 
typedef int(* CoinParamFunc )(CoinParam *param)
 Type declaration for push and pull functions. More...
 

Public Member Functions

Constructors and Destructors

Be careful how you specify parameters for the constructors! There's great potential for confusion.

 CbcGenParam ()
 Default constructor. More...
 
 CbcGenParam (CbcGenParamCode 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...
 
 CbcGenParam (CbcGenParamCode 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...
 
 CbcGenParam (CbcGenParamCode code, std::string name, std::string help, std::string firstValue, int dflt, bool display=true)
 Constructor for a parameter with keyword values. More...
 
 CbcGenParam (CbcGenParamCode code, std::string name, std::string help, std::string dflt, bool display=true)
 Constructor for a string parameter. More...
 
 CbcGenParam (CbcGenParamCode code, std::string name, std::string help, bool display=true)
 Constructor for an action parameter. More...
 
 CbcGenParam (const CbcGenParam &orig)
 Copy constructor. More...
 
CbcGenParamclone ()
 Clone. More...
 
CbcGenParamoperator= (const CbcGenParam &rhs)
 Assignment. More...
 
 ~CbcGenParam ()
 Destructor. More...
 
Methods to query and manipulate a parameter object
CbcGenParamCode paramCode () const
 Get the parameter code. More...
 
void setParamCode (CbcGenParamCode code)
 Set the parameter code. More...
 
CbcGenCtlBlkobj () const
 Get the underlying cbc-generic control object. More...
 
void setObj (CbcGenCtlBlk *obj)
 Set the underlying cbc-generic control object. More...
 
- Public Member Functions inherited from CoinParam
 CoinParam ()
 Default constructor. More...
 
 CoinParam (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...
 
 CoinParam (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...
 
 CoinParam (std::string name, std::string help, std::string firstValue, int dflt, bool display=true)
 Constructor for a parameter with keyword values. More...
 
 CoinParam (std::string name, std::string help, std::string dflt, bool display=true)
 Constructor for a string parameter. More...
 
 CoinParam (std::string name, std::string help, bool display=true)
 Constructor for an action parameter. More...
 
 CoinParam (const CoinParam &orig)
 Copy constructor. More...
 
CoinParamoperator= (const CoinParam &rhs)
 Assignment. More...
 
virtual ~CoinParam ()
 Destructor. More...
 
void appendKwd (std::string kwd)
 Add an additional value-keyword to a keyword parameter. More...
 
int kwdIndex (std::string kwd) const
 Return the integer associated with the specified value-keyword. More...
 
std::string kwdVal () const
 Return the value-keyword that is the current value of the keyword parameter. More...
 
void setKwdVal (int value, bool printIt=false)
 Set the value of the keyword parameter using the integer associated with a value-keyword. More...
 
void setKwdVal (const std::string value)
 Set the value of the keyword parameter using a value-keyword string. More...
 
void printKwds () const
 Prints the set of value-keywords defined for this keyword parameter. More...
 
void setStrVal (std::string value)
 Set the value of a string parameter. More...
 
std::string strVal () const
 Get the value of a string parameter. More...
 
void setDblVal (double value)
 Set the value of a double parameter. More...
 
double dblVal () const
 Get the value of a double parameter. More...
 
void setIntVal (int value)
 Set the value of a integer parameter. More...
 
int intVal () const
 Get the value of a integer parameter. More...
 
void setShortHelp (const std::string help)
 Add a short help string to a parameter. More...
 
std::string shortHelp () const
 Retrieve the short help string. More...
 
void setLongHelp (const std::string help)
 Add a long help message to a parameter. More...
 
std::string longHelp () const
 Retrieve the long help message. More...
 
void printLongHelp () const
 Print long help. More...
 
CoinParamType type () const
 Return the type of the parameter. More...
 
void setType (CoinParamType type)
 Set the type of the parameter. More...
 
std::string name () const
 Return the parameter keyword (name) string. More...
 
void setName (std::string name)
 Set the parameter keyword (name) string. More...
 
int matches (std::string input) const
 Check if the specified string matches the parameter keyword (name) string. More...
 
std::string matchName () const
 Return the parameter keyword (name) string formatted to show the minimum match length. More...
 
void setDisplay (bool display)
 Set visibility of parameter. More...
 
bool display () const
 Get visibility of parameter. More...
 
CoinParamFunc pushFunc ()
 Get push function. More...
 
void setPushFunc (CoinParamFunc func)
 Set push function. More...
 
CoinParamFunc pullFunc ()
 Get pull function. More...
 
void setPullFunc (CoinParamFunc func)
 Set pull function. More...
 

Private Attributes

Data
CbcGenParamCode paramCode_
 Parameter code. More...
 
CbcGenCtlBlkobj_
 cbc-generic control object More...
 

Additional Inherited Members

Detailed Description

Class for cbc-generic control parameters.

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

Definition at line 34 of file CbcGenParam.hpp.

Member Enumeration Documentation

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.

Enumerator
CBCGEN_FIRSTPARAM 
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 

Definition at line 49 of file CbcGenParam.hpp.

Constructor & Destructor Documentation

CbcGenParam::CbcGenParam ( )

Default constructor.

CbcGenParam::CbcGenParam ( CbcGenParamCode  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.

CbcGenParam::CbcGenParam ( CbcGenParamCode  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.

CbcGenParam::CbcGenParam ( CbcGenParamCode  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.

CbcGenParam::CbcGenParam ( CbcGenParamCode  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.

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

Constructor for an action parameter.

CbcGenParam::CbcGenParam ( const CbcGenParam orig)

Copy constructor.

CbcGenParam::~CbcGenParam ( )

Destructor.

Member Function Documentation

CbcGenParam* CbcGenParam::clone ( )
virtual

Clone.

Reimplemented from CoinParam.

CbcGenParam& CbcGenParam::operator= ( const CbcGenParam rhs)

Assignment.

CbcGenParamCode CbcGenParam::paramCode ( ) const
inline

Get the parameter code.

Definition at line 148 of file CbcGenParam.hpp.

void CbcGenParam::setParamCode ( CbcGenParamCode  code)
inline

Set the parameter code.

Definition at line 154 of file CbcGenParam.hpp.

CbcGenCtlBlk* CbcGenParam::obj ( ) const
inline

Get the underlying cbc-generic control object.

Definition at line 160 of file CbcGenParam.hpp.

void CbcGenParam::setObj ( CbcGenCtlBlk obj)
inline

Set the underlying cbc-generic control object.

Definition at line 166 of file CbcGenParam.hpp.

Member Data Documentation

CbcGenParamCode CbcGenParam::paramCode_
private

Parameter code.

Definition at line 179 of file CbcGenParam.hpp.

CbcGenCtlBlk* CbcGenParam::obj_
private

cbc-generic control object

Definition at line 182 of file CbcGenParam.hpp.


The documentation for this class was generated from the following file: