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 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...

CbcGenParam *	clone ()
	Clone. More...

CbcGenParam &	operator= (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...

CbcGenCtlBlk *	obj () const
	Get the underlying cbc-generic control object. More...

void	setObj (CbcGenCtlBlk *obj)
	Set the underlying cbc-generic control object. More...

Private Attributes
Data
CbcGenParamCode	paramCode_
	Parameter code. More...

CbcGenCtlBlk *	obj_
	cbc-generic control object More...

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

◆ CbcGenParamCode

enum CbcGenParam::CbcGenParamCode

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 48 of file CbcGenParam.hpp.

Constructor & Destructor Documentation

◆ CbcGenParam() [1/7]

CbcGenParam::CbcGenParam ( )

Default constructor.

◆ CbcGenParam() [2/7]

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() [3/7]

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() [4/7]

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() [5/7]

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() [6/7]

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

Constructor for an action parameter.

◆ CbcGenParam() [7/7]

CbcGenParam::CbcGenParam ( const CbcGenParam & orig )

Copy constructor.

◆ ~CbcGenParam()

CbcGenParam::~CbcGenParam ( )

Destructor.

Member Function Documentation

◆ clone()

CbcGenParam* CbcGenParam::clone ( )

Clone.

◆ operator=()

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

Assignment.

◆ paramCode()

CbcGenParamCode CbcGenParam::paramCode ( ) const

inline

Get the parameter code

Definition at line 190 of file CbcGenParam.hpp.

◆ setParamCode()

void CbcGenParam::setParamCode ( CbcGenParamCode code )

inline

Set the parameter code.

Definition at line 197 of file CbcGenParam.hpp.

◆ obj()

CbcGenCtlBlk* CbcGenParam::obj ( ) const

inline

Get the underlying cbc-generic control object.

Definition at line 204 of file CbcGenParam.hpp.

◆ setObj()

void CbcGenParam::setObj ( CbcGenCtlBlk * obj )

inline

Set the underlying cbc-generic control object.

Definition at line 211 of file CbcGenParam.hpp.

Member Data Documentation

◆ paramCode_

CbcGenParamCode CbcGenParam::paramCode_

private

Parameter code.

Definition at line 223 of file CbcGenParam.hpp.

◆ obj_

CbcGenCtlBlk* CbcGenParam::obj_

private

cbc-generic control object

Definition at line 226 of file CbcGenParam.hpp.

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

/home/ted/Projects/Cbc/Cbc/src/CbcGenParam.hpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ CbcGenParamCode

Constructor & Destructor Documentation

◆ CbcGenParam() [1/7]

◆ CbcGenParam() [2/7]

◆ CbcGenParam() [3/7]

◆ CbcGenParam() [4/7]

◆ CbcGenParam() [5/7]

◆ CbcGenParam() [6/7]

◆ CbcGenParam() [7/7]

◆ ~CbcGenParam()

Member Function Documentation

◆ clone()

◆ operator=()

◆ paramCode()

◆ setParamCode()

◆ obj()

◆ setObj()

Member Data Documentation

◆ paramCode_

◆ obj_