This allows the use of the standalone solver in a flexible manner. More...

#include <CbcSolver.hpp>

Collaboration diagram for CbcSolver:

Public Member Functions
Solve method
int	solve (int argc, const char *argv[], int returnMode)
	This takes a list of commands, does "stuff" and returns returnMode - 0 model and solver untouched - babModel updated 1 model updated - just with solution basis etc 2 model updated i.e. More...

int	solve (const char *input, int returnMode)
	This takes a list of commands, does "stuff" and returns returnMode - 0 model and solver untouched - babModel updated 1 model updated - just with solution basis etc 2 model updated i.e. More...

Constructors and destructors etc
	CbcSolver ()
	Default Constructor. More...

	CbcSolver (const OsiClpSolverInterface &)
	Constructor from solver. More...

	CbcSolver (const CbcModel &)
	Constructor from model. More...

	CbcSolver (const CbcSolver &rhs)
	Copy constructor . More...

CbcSolver &	operator= (const CbcSolver &rhs)
	Assignment operator. More...

	~CbcSolver ()
	Destructor. More...

void	fillParameters ()
	Fill with standard parameters. More...

void	fillValuesInSolver ()
	Set default values in solvers from parameters. More...

void	addUserFunction (CbcUser *function)
	Add user function. More...

void	setUserCallBack (CbcStopNow *function)
	Set user call back. More...

void	addCutGenerator (CglCutGenerator *generator)
	Add cut generator. More...

miscellaneous methods to line up with old
int *	analyze (OsiClpSolverInterface solverMod, int &numberChanged, double &increment, bool changeInt, CoinMessageHandler generalMessageHandler)

void	updateModel (ClpSimplex *model2, int returnMode)
	1 - add heuristics to model 2 - do heuristics (and set cutoff and best solution) 3 - for miplib test so skip some (out model later) More...

useful stuff
int	intValue (CbcOrClpParameterType type) const
	Get int value. More...

void	setIntValue (CbcOrClpParameterType type, int value)
	Set int value. More...

double	doubleValue (CbcOrClpParameterType type) const
	Get double value. More...

void	setDoubleValue (CbcOrClpParameterType type, double value)
	Set double value. More...

CbcUser *	userFunction (const char *name) const
	User function (NULL if no match) More...

CbcModel *	model ()
	Return original Cbc model. More...

CbcModel *	babModel ()
	Return updated Cbc model. More...

int	numberUserFunctions () const
	Number of userFunctions. More...

CbcUser **	userFunctionArray () const
	User function array. More...

OsiClpSolverInterface *	originalSolver () const
	Copy of model on initial load (will contain output solutions) More...

CoinModel *	originalCoinModel () const
	Copy of model on initial load. More...

void	setOriginalSolver (OsiClpSolverInterface *originalSolver)
	Copy of model on initial load (will contain output solutions) More...

void	setOriginalCoinModel (CoinModel *originalCoinModel)
	Copy of model on initial load. More...

int	numberCutGenerators () const
	Number of cutgenerators. More...

CglCutGenerator **	cutGeneratorArray () const
	Cut generator array. More...

double	startTime () const
	Start time. More...

void	setPrinting (bool onOff)
	Whether to print to std::cout. More...

void	setReadMode (int value)
	Where to start reading commands. More...

Private Attributes
Private member data
CbcModel	model_
	Reference model. More...

CbcModel *	babModel_
	Updated model. More...

CbcUser **	userFunction_
	User functions. More...

int *	statusUserFunction_
	Status of user functions 0 - not used 1 - needs cbc_load 2 - available - data in coinModel 3 - data loaded - can do cbc_save. More...

OsiClpSolverInterface *	originalSolver_
	Copy of model on initial load (will contain output solutions) More...

CoinModel *	originalCoinModel_
	Copy of model on initial load. More...

CglCutGenerator **	cutGenerator_
	Cut generators. More...

int	numberUserFunctions_
	Number of user functions. More...

int	numberCutGenerators_
	Number of cut generators. More...

CbcStopNow *	callBack_
	Stop now stuff. More...

double	startTime_
	Cpu time at instantiation. More...

std::vector< CbcOrClpParam >	parameters_
	Parameters and values. More...

bool	doMiplib_
	Whether to do miplib test. More...

bool	noPrinting_
	Whether to print to std::cout. More...

int	readMode_
	Where to start reading commands. More...

Detailed Description

This allows the use of the standalone solver in a flexible manner.

It has an original OsiClpSolverInterface and CbcModel which it can use repeatedly, e.g., to get a heuristic solution and then start again.

So I [jjf] will need a primitive scripting language which can then call solve and manipulate solution value and solution arrays.

Also provides for user callback functions. Currently two ideas in gestation, CbcUser and CbcStopNow. The latter seems limited to deciding whether or not to stop. The former seems completely general, with a notion of importing and exporting, and a ‘solve’, which should be interpreted as ‘do whatever this user function does’.

Parameter initialisation is at last centralised in fillParameters().

Definition at line 55 of file CbcSolver.hpp.

Constructor & Destructor Documentation

◆ CbcSolver() [1/4]

CbcSolver::CbcSolver ( )

Default Constructor.

◆ CbcSolver() [2/4]

CbcSolver::CbcSolver ( const OsiClpSolverInterface & )

Constructor from solver.

◆ CbcSolver() [3/4]

CbcSolver::CbcSolver ( const CbcModel & )

Constructor from model.

◆ CbcSolver() [4/4]

CbcSolver::CbcSolver ( const CbcSolver & rhs )

Copy constructor .

◆ ~CbcSolver()

CbcSolver::~CbcSolver ( )

Destructor.

Member Function Documentation

◆ solve() [1/2]

int CbcSolver::solve	(	int	argc,
		const char *	argv[],
		int	returnMode
	)

This takes a list of commands, does "stuff" and returns returnMode - 0 model and solver untouched - babModel updated 1 model updated - just with solution basis etc 2 model updated i.e.

as babModel (babModel NULL) (only use without preprocessing)

◆ solve() [2/2]

int CbcSolver::solve	(	const char *	input,
		int	returnMode
	)

This takes a list of commands, does "stuff" and returns returnMode - 0 model and solver untouched - babModel updated 1 model updated - just with solution basis etc 2 model updated i.e.

as babModel (babModel NULL) (only use without preprocessing)

◆ operator=()

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

Assignment operator.

◆ fillParameters()

void CbcSolver::fillParameters ( )

Fill with standard parameters.

◆ fillValuesInSolver()

void CbcSolver::fillValuesInSolver ( )

Set default values in solvers from parameters.

Misleading. The current code actually reads default values from the underlying solvers and installs them as default values for a subset of parameters in parameters_.

◆ addUserFunction()

void CbcSolver::addUserFunction ( CbcUser * function )

Add user function.

◆ setUserCallBack()

void CbcSolver::setUserCallBack ( CbcStopNow * function )

Set user call back.

◆ addCutGenerator()

void CbcSolver::addCutGenerator ( CglCutGenerator * generator )

Add cut generator.

◆ analyze()

int* CbcSolver::analyze	(	OsiClpSolverInterface *	solverMod,
		int &	numberChanged,
		double &	increment,
		bool	changeInt,
		CoinMessageHandler *	generalMessageHandler
	)

◆ updateModel()

void CbcSolver::updateModel	(	ClpSimplex *	model2,
		int	returnMode
	)

1 - add heuristics to model 2 - do heuristics (and set cutoff and best solution) 3 - for miplib test so skip some (out model later)

Updates model_ from babModel_ according to returnMode returnMode - 0 model and solver untouched - babModel updated 1 model updated - just with solution basis etc 2 model updated i.e. as babModel (babModel NULL) (only use without preprocessing)

◆ intValue()

int CbcSolver::intValue ( CbcOrClpParameterType type ) const

Get int value.

◆ setIntValue()

void CbcSolver::setIntValue	(	CbcOrClpParameterType	type,
		int	value
	)

Set int value.

◆ doubleValue()

double CbcSolver::doubleValue ( CbcOrClpParameterType type ) const

Get double value.

◆ setDoubleValue()

void CbcSolver::setDoubleValue	(	CbcOrClpParameterType	type,
		double	value
	)

Set double value.

◆ userFunction()

CbcUser* CbcSolver::userFunction ( const char * name ) const

User function (NULL if no match)

◆ model()

CbcModel* CbcSolver::model ( )

inline

Return original Cbc model.

Definition at line 143 of file CbcSolver.hpp.

◆ babModel()

CbcModel* CbcSolver::babModel ( )

inline

Return updated Cbc model.

Definition at line 148 of file CbcSolver.hpp.

◆ numberUserFunctions()

int CbcSolver::numberUserFunctions ( ) const

inline

Number of userFunctions.

Definition at line 153 of file CbcSolver.hpp.

◆ userFunctionArray()

CbcUser** CbcSolver::userFunctionArray ( ) const

inline

User function array.

Definition at line 158 of file CbcSolver.hpp.

◆ originalSolver()

OsiClpSolverInterface* CbcSolver::originalSolver ( ) const

inline

Copy of model on initial load (will contain output solutions)

Definition at line 163 of file CbcSolver.hpp.

◆ originalCoinModel()

CoinModel* CbcSolver::originalCoinModel ( ) const

inline

Copy of model on initial load.

Definition at line 168 of file CbcSolver.hpp.

◆ setOriginalSolver()

void CbcSolver::setOriginalSolver ( OsiClpSolverInterface * originalSolver )

Copy of model on initial load (will contain output solutions)

◆ setOriginalCoinModel()

void CbcSolver::setOriginalCoinModel ( CoinModel * originalCoinModel )

Copy of model on initial load.

◆ numberCutGenerators()

int CbcSolver::numberCutGenerators ( ) const

inline

Number of cutgenerators.

Definition at line 177 of file CbcSolver.hpp.

◆ cutGeneratorArray()

CglCutGenerator** CbcSolver::cutGeneratorArray ( ) const

inline

Cut generator array.

Definition at line 182 of file CbcSolver.hpp.

◆ startTime()

double CbcSolver::startTime ( ) const

inline

Start time.

Definition at line 187 of file CbcSolver.hpp.

◆ setPrinting()

void CbcSolver::setPrinting ( bool onOff )

inline

Whether to print to std::cout.

Definition at line 192 of file CbcSolver.hpp.

◆ setReadMode()

void CbcSolver::setReadMode ( int value )

inline

Where to start reading commands.

Definition at line 197 of file CbcSolver.hpp.

Member Data Documentation

◆ model_

CbcModel CbcSolver::model_

private

Reference model.

Definition at line 207 of file CbcSolver.hpp.

◆ babModel_

CbcModel* CbcSolver::babModel_

private

Updated model.

Definition at line 210 of file CbcSolver.hpp.

◆ userFunction_

CbcUser** CbcSolver::userFunction_

private

User functions.

Definition at line 213 of file CbcSolver.hpp.

◆ statusUserFunction_

int* CbcSolver::statusUserFunction_

private

Status of user functions 0 - not used 1 - needs cbc_load 2 - available - data in coinModel 3 - data loaded - can do cbc_save.

Definition at line 220 of file CbcSolver.hpp.

◆ originalSolver_

OsiClpSolverInterface* CbcSolver::originalSolver_

private

Copy of model on initial load (will contain output solutions)

Definition at line 222 of file CbcSolver.hpp.

◆ originalCoinModel_

CoinModel* CbcSolver::originalCoinModel_

private

Copy of model on initial load.

Definition at line 224 of file CbcSolver.hpp.

◆ cutGenerator_

CglCutGenerator** CbcSolver::cutGenerator_

private

Cut generators.

Definition at line 226 of file CbcSolver.hpp.

◆ numberUserFunctions_

int CbcSolver::numberUserFunctions_

private

Number of user functions.

Definition at line 228 of file CbcSolver.hpp.

◆ numberCutGenerators_

int CbcSolver::numberCutGenerators_

private

Number of cut generators.

Definition at line 230 of file CbcSolver.hpp.

◆ callBack_

CbcStopNow* CbcSolver::callBack_

private

Stop now stuff.

Definition at line 232 of file CbcSolver.hpp.

◆ startTime_

double CbcSolver::startTime_

private

Cpu time at instantiation.

Definition at line 234 of file CbcSolver.hpp.

◆ parameters_

std::vector< CbcOrClpParam > CbcSolver::parameters_

private

Parameters and values.

Definition at line 236 of file CbcSolver.hpp.

◆ doMiplib_

bool CbcSolver::doMiplib_

private

Whether to do miplib test.

Definition at line 238 of file CbcSolver.hpp.

◆ noPrinting_

bool CbcSolver::noPrinting_

private

Whether to print to std::cout.

Definition at line 240 of file CbcSolver.hpp.

◆ readMode_

int CbcSolver::readMode_

private

Where to start reading commands.

Definition at line 242 of file CbcSolver.hpp.

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbcSolver() [1/4]

◆ CbcSolver() [2/4]

◆ CbcSolver() [3/4]

◆ CbcSolver() [4/4]

◆ ~CbcSolver()

Member Function Documentation

◆ solve() [1/2]

◆ solve() [2/2]

◆ operator=()

◆ fillParameters()

◆ fillValuesInSolver()

◆ addUserFunction()

◆ setUserCallBack()

◆ addCutGenerator()

◆ analyze()

◆ updateModel()

◆ intValue()

◆ setIntValue()

◆ doubleValue()

◆ setDoubleValue()

◆ userFunction()

◆ model()

◆ babModel()

◆ numberUserFunctions()

◆ userFunctionArray()

◆ originalSolver()

◆ originalCoinModel()

◆ setOriginalSolver()

◆ setOriginalCoinModel()

◆ numberCutGenerators()

◆ cutGeneratorArray()

◆ startTime()

◆ setPrinting()

◆ setReadMode()

Member Data Documentation

◆ model_

◆ babModel_

◆ userFunction_

◆ statusUserFunction_

◆ originalSolver_

◆ originalCoinModel_

◆ cutGenerator_

◆ numberUserFunctions_

◆ numberCutGenerators_

◆ callBack_

◆ startTime_

◆ parameters_

◆ doMiplib_

◆ noPrinting_

◆ readMode_