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

Class for control parameters that act on a OsiSolverInterface object. More...

#include <CbcGenOsiParam.hpp>

+ Inheritance diagram for CbcOsiParam:
+ Collaboration diagram for CbcOsiParam:

Public Types

Subtypes
enum  CbcOsiParamCode {
  CBCOSI_FIRSTPARAM = CbcCbcParam::CBCCBC_LASTPARAM + 1, ALGORITHM, ALLSLACK, AUTOSCALE,
  BARRIER, BARRIERSCALE, BASISIN, BASISOUT,
  BIASLU, CHOLESKY, CRASH, CROSSOVER,
  DUALBOUND, DUALPIVOT, DUALSIMPLEX, DUALTOLERANCE,
  FAKEBOUND, GAMMA, IDIOT, KEEPNAMES,
  KKT, MAXITERATION, MAXHOTITS, NETLIB_BARRIER,
  NETLIB_DUAL, NETLIB_PRIMAL, NETWORK, OBJSCALE,
  PERTURBATION, PERTVALUE, PFI, PLUSMINUS,
  PRESOLVE, PRESOLVEOPTIONS, PRESOLVEPASS, PRIMALPIVOT,
  PRIMALSIMPLEX, PRIMALTOLERANCE, REALLY_SCALE, RESTORE,
  REVERSE, RHSSCALE, SAVE, SCALING,
  SLPVALUE, SOLVERLOGLEVEL, SPARSEFACTOR, SPECIALOPTIONS,
  SPRINT, TIGHTEN, CBCOSI_LASTPARAM
}
 Enumeration for parameters that control an OsiSolverInterface object. 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.

 CbcOsiParam ()
 Default constructor. More...
 
 CbcOsiParam (CbcOsiParamCode 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...
 
 CbcOsiParam (CbcOsiParamCode 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...
 
 CbcOsiParam (CbcOsiParamCode code, std::string name, std::string help, std::string firstValue, int dflt, bool display=true)
 Constructor for a parameter with keyword values. More...
 
 CbcOsiParam (CbcOsiParamCode code, std::string name, std::string help, std::string dflt, bool display=true)
 Constructor for a string parameter. More...
 
 CbcOsiParam (CbcOsiParamCode code, std::string name, std::string help, bool display=true)
 Constructor for an action parameter. More...
 
 CbcOsiParam (const CbcOsiParam &orig)
 Copy constructor. More...
 
CbcOsiParamclone ()
 Clone. More...
 
CbcOsiParamoperator= (const CbcOsiParam &rhs)
 Assignment. More...
 
 ~CbcOsiParam ()
 Destructor. More...
 
Methods to query and manipulate a parameter object
CbcOsiParamCode paramCode () const
 Get the parameter code. More...
 
void setParamCode (CbcOsiParamCode code)
 Set the parameter code. More...
 
OsiSolverInterfaceobj () const
 Get the underlying OsiSolverInterface object. More...
 
void setObj (OsiSolverInterface *obj)
 Set the underlying OsiSolverInterace 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
CbcOsiParamCode paramCode_
 Parameter code. More...
 
OsiSolverInterfaceobj_
 OsiSolverInterface object. More...
 

Additional Inherited Members

Detailed Description

Class for control parameters that act on a OsiSolverInterface object.

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

Definition at line 31 of file CbcGenOsiParam.hpp.

Member Enumeration Documentation

Enumeration for parameters that control an OsiSolverInterface object.

These are parameters that control the operation of an OsiSolverInterface object. CBCOSI_FIRSTPARAM and CBCOSI_LASTPARAM are markers to allow convenient separation of parameter groups.

Enumerator
CBCOSI_FIRSTPARAM 
ALGORITHM 
ALLSLACK 
AUTOSCALE 
BARRIER 
BARRIERSCALE 
BASISIN 
BASISOUT 
BIASLU 
CHOLESKY 
CRASH 
CROSSOVER 
DUALBOUND 
DUALPIVOT 
DUALSIMPLEX 
DUALTOLERANCE 
FAKEBOUND 
GAMMA 
IDIOT 
KEEPNAMES 
KKT 
MAXITERATION 
MAXHOTITS 
NETLIB_BARRIER 
NETLIB_DUAL 
NETLIB_PRIMAL 
NETWORK 
OBJSCALE 
PERTURBATION 
PERTVALUE 
PFI 
PLUSMINUS 
PRESOLVE 
PRESOLVEOPTIONS 
PRESOLVEPASS 
PRIMALPIVOT 
PRIMALSIMPLEX 
PRIMALTOLERANCE 
REALLY_SCALE 
RESTORE 
REVERSE 
RHSSCALE 
SAVE 
SCALING 
SLPVALUE 
SOLVERLOGLEVEL 
SPARSEFACTOR 
SPECIALOPTIONS 
SPRINT 
TIGHTEN 
CBCOSI_LASTPARAM 

Definition at line 46 of file CbcGenOsiParam.hpp.

Constructor & Destructor Documentation

CbcOsiParam::CbcOsiParam ( )

Default constructor.

CbcOsiParam::CbcOsiParam ( CbcOsiParamCode  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.

CbcOsiParam::CbcOsiParam ( CbcOsiParamCode  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.

CbcOsiParam::CbcOsiParam ( CbcOsiParamCode  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.

CbcOsiParam::CbcOsiParam ( CbcOsiParamCode  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.

CbcOsiParam::CbcOsiParam ( CbcOsiParamCode  code,
std::string  name,
std::string  help,
bool  display = true 
)

Constructor for an action parameter.

CbcOsiParam::CbcOsiParam ( const CbcOsiParam orig)

Copy constructor.

CbcOsiParam::~CbcOsiParam ( )

Destructor.

Member Function Documentation

CbcOsiParam* CbcOsiParam::clone ( )
virtual

Clone.

Reimplemented from CoinParam.

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

Assignment.

CbcOsiParamCode CbcOsiParam::paramCode ( ) const
inline

Get the parameter code.

Definition at line 141 of file CbcGenOsiParam.hpp.

void CbcOsiParam::setParamCode ( CbcOsiParamCode  code)
inline

Set the parameter code.

Definition at line 147 of file CbcGenOsiParam.hpp.

OsiSolverInterface* CbcOsiParam::obj ( ) const
inline

Get the underlying OsiSolverInterface object.

Definition at line 153 of file CbcGenOsiParam.hpp.

void CbcOsiParam::setObj ( OsiSolverInterface obj)
inline

Set the underlying OsiSolverInterace object.

Definition at line 159 of file CbcGenOsiParam.hpp.

Member Data Documentation

CbcOsiParamCode CbcOsiParam::paramCode_
private

Parameter code.

Definition at line 172 of file CbcGenOsiParam.hpp.

OsiSolverInterface* CbcOsiParam::obj_
private

OsiSolverInterface object.

Definition at line 175 of file CbcGenOsiParam.hpp.


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