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

CbcOsiParam *	clone ()
	Clone. More...

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

OsiSolverInterface *	obj () const
	Get the underlying OsiSolverInterface object. More...

void	setObj (OsiSolverInterface *obj)
	Set the underlying OsiSolverInterace object. More...

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

OsiSolverInterface *	obj_
	OsiSolverInterface object. More...

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

◆ CbcOsiParamCode

enum CbcOsiParam::CbcOsiParamCode

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 45 of file CbcGenOsiParam.hpp.

Constructor & Destructor Documentation

◆ CbcOsiParam() [1/7]

CbcOsiParam::CbcOsiParam ( )

Default constructor.

◆ CbcOsiParam() [2/7]

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

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

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

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

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

Constructor for an action parameter.

◆ CbcOsiParam() [7/7]

CbcOsiParam::CbcOsiParam ( const CbcOsiParam & orig )

Copy constructor.

◆ ~CbcOsiParam()

CbcOsiParam::~CbcOsiParam ( )

Destructor.

Member Function Documentation

◆ clone()

CbcOsiParam* CbcOsiParam::clone ( )

Clone.

◆ operator=()

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

Assignment.

◆ paramCode()

CbcOsiParamCode CbcOsiParam::paramCode ( ) const

inline

Get the parameter code

Definition at line 180 of file CbcGenOsiParam.hpp.

◆ setParamCode()

void CbcOsiParam::setParamCode ( CbcOsiParamCode code )

inline

Set the parameter code.

Definition at line 187 of file CbcGenOsiParam.hpp.

◆ obj()

OsiSolverInterface* CbcOsiParam::obj ( ) const

inline

Get the underlying OsiSolverInterface object.

Definition at line 194 of file CbcGenOsiParam.hpp.

◆ setObj()

void CbcOsiParam::setObj ( OsiSolverInterface * obj )

inline

Set the underlying OsiSolverInterace object.

Definition at line 201 of file CbcGenOsiParam.hpp.

Member Data Documentation

◆ paramCode_

CbcOsiParamCode CbcOsiParam::paramCode_

private

Parameter code.

Definition at line 213 of file CbcGenOsiParam.hpp.

◆ obj_

OsiSolverInterface* CbcOsiParam::obj_

private

OsiSolverInterface object.

Definition at line 216 of file CbcGenOsiParam.hpp.

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

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

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ CbcOsiParamCode

Constructor & Destructor Documentation

◆ CbcOsiParam() [1/7]

◆ CbcOsiParam() [2/7]

◆ CbcOsiParam() [3/7]

◆ CbcOsiParam() [4/7]

◆ CbcOsiParam() [5/7]

◆ CbcOsiParam() [6/7]

◆ CbcOsiParam() [7/7]

◆ ~CbcOsiParam()

Member Function Documentation

◆ clone()

◆ operator=()

◆ paramCode()

◆ setParamCode()

◆ obj()

◆ setObj()

Member Data Documentation

◆ paramCode_

◆ obj_