The CbcEngine class can be called to solve MILP problems. More...

#include <CbcEngine.h>

Inheritance diagram for Minotaur::CbcEngine:

Collaboration diagram for Minotaur::CbcEngine:

[legend]

Public Member Functions
	CbcEngine (EnvPtr env)
	Constructor with an environment.

	~CbcEngine ()
	Destroy.

void	addConstraint (ConstraintPtr)
	Add a new constraint to the engine. More...

void	changeBound (ConstraintPtr cons, BoundType lu, double new_val)
	Change a bound of a constraint. More...

void	changeBound (VariablePtr var, BoundType lu, double new_val)
	Change a bound of a variable. More...

void	changeBound (VariablePtr var, double new_lb, double new_ub)
	Change both bounds of a variable. More...

void	changeConstraint (ConstraintPtr con, LinearFunctionPtr lf, double lb, double ub)
	Change the linear function, and the bounds of a constraint. More...

void	changeConstraint (ConstraintPtr c, NonlinearFunctionPtr nlf)
	Change the nonlinear function, and the bounds of a constraint. More...

void	changeObj (FunctionPtr f, double cb)
	Change objective function. More...

void	clear ()
	Clear the problem. More...

void	disableStrBrSetup ()
	Restore settings after strong branching. More...

EnginePtr	emptyCopy ()
	Return an empty CbcEngine pointer. More...

void	enableStrBrSetup ()
	Make settings for strong branching. More...

UInt	getNumSols ()
	Get the number of solutions in the solution pool of Cbc. More...

double	getSolutionValue ()
	Return the solution value of the objective after solving the LP. More...

ConstSolutionPtr	getSolution ()
	Get the solution obtained after solving the problem. More...

ConstSolutionPtr	getSolutionFromPool (int)
	Get a particular solution from solution pool. More...

EngineStatus	getStatus ()
	Get the status of the last solve command. More...

std::string	getName () const
	Get the name. More...

ConstWarmStartPtr	getWarmStart ()

WarmStartPtr	getWarmStartCopy ()

void	load (ProblemPtr problem)

void	loadFromWarmStart (const WarmStartPtr)

void	negateObj ()
	Negate the objective function. Min f is changed to Min -f. More...

void	removeCons (std::vector< ConstraintPtr > &delcons)
	Delete constraints from the engine. More...

void	resetIterationLimit ()
	Reset the iteration limit to maximum possible. More...

void	setIterationLimit (int limit)

int	setDualObjLimit (double)
	Set the dual objective limit. More...

void	setTimeLimit (double)
	Set time limit for an iteration. More...

void	setUpperCutoff (double)
	Set upper cutoff for an iteration. More...

EngineStatus	solve ()

void	writeLP (const char *filename) const
	Writes an LP file of the loaded LP.

void	writeStats (std::ostream &out) const
	Write statistics. More...

Public Member Functions inherited from Minotaur::MILPEngine
	MILPEngine ()
	Constructor. May set default parameters/options here.

virtual	~MILPEngine ()
	Destructor must be implemented if memory needs to be freed.

virtual void	setTimeLimit (double)=0
	Set time limit for an iteration. More...

virtual void	setUpperCutoff (double)=0
	Set upper cutoff for an iteration. More...

virtual UInt	getNumSols ()=0
	Get number of solutions in the solution pool of MILP engine. More...

virtual ConstSolutionPtr	getSolutionFromPool (int)=0
	Get a particular solution from solution pool. More...

Public Member Functions inherited from Minotaur::Engine
	Engine ()
	Default constructor.

virtual	~Engine ()
	Destroy.

virtual void	addConstraint (ConstraintPtr)=0
	Add a new constraint to the engine. More...

virtual void	changeBound (ConstraintPtr cons, BoundType lu, double new_val)=0
	Change a bound of a constraint. More...

virtual void	changeBound (VariablePtr var, BoundType lu, double new_val)=0
	Change a bound of a variable. More...

virtual void	changeBound (VariablePtr var, double new_lb, double new_ub)=0
	Change both bounds of a variable. More...

virtual void	changeConstraint (ConstraintPtr c, LinearFunctionPtr lf, double lb, double ub)=0
	Change the linear function, and the bounds of a constraint. More...

virtual void	changeConstraint (ConstraintPtr c, NonlinearFunctionPtr nlf)=0
	Change the nonlinear function, and the bounds of a constraint. More...

virtual void	changeObj (FunctionPtr f, double cb)=0
	Change objective function. More...

virtual void	clear ()=0
	Clear the loaded problem, if any, from the engine. More...

virtual void	disableStrBrSetup ()=0
	Restore settings after strong branching. More...

virtual EnginePtr	emptyCopy ()
	Get a fresh copy of the engine, without the problem loaded into it. More...

virtual void	enableStrBrSetup ()=0
	Make settings for strong branching. More...

virtual ConstSolutionPtr	getSolution ()=0
	Get the solution obtained after solving the problem. More...

virtual double	getSolutionValue ()=0
	Get the solution value. More...

virtual EngineStatus	solve ()=0
	Solve the problem that was loaded previously. More...

virtual std::string	getName () const =0
	Get the name. More...

virtual EngineStatus	getStatus ()=0
	Get the status of the last solve command. More...

virtual std::string	getStatusString ()
	Return a string that describes the status in simple words.

virtual ConstWarmStartPtr	getWarmStart ()=0

virtual WarmStartPtr	getWarmStartCopy ()=0

virtual void	load (ProblemPtr problem)=0

virtual void	loadFromWarmStart (const WarmStartPtr ws)=0

virtual void	negateObj ()=0
	Negate the objective function. Min f is changed to Min -f. More...

virtual LoggerPtr	getLogger ()
	Return pointer to the log manager.

virtual void	removeCons (std::vector< ConstraintPtr > &delcons)=0
	Delete constraints from the engine. More...

virtual void	resetIterationLimit ()=0
	Reset the iteration limit to maximum possible. More...

virtual int	setDualObjLimit (double)=0
	Set the dual objective limit. More...

virtual void	setIterationLimit (int limit)=0

virtual void	setLogger (LoggerPtr logger)
	Set a new log manager.

virtual void	setOptionsForSingleSolve ()

virtual void	setOptionsForRepeatedSolve ()
	Set options to solve the NLP repeatedly, with few changes. More...

virtual void	writeStats (std::ostream &) const

virtual void	fillStats (std::vector< double > &)
	Accumulate statistics from different threads in a common data. More...

Additional Inherited Members
Protected Attributes inherited from Minotaur::Engine
EngineStatus	status_
	Status of the last solve.

LoggerPtr	logger_
	Keep log.

Detailed Description

The CbcEngine class can be called to solve MILP problems.

Member Function Documentation

◆ addConstraint()

void CbcEngine::addConstraint ( ConstraintPtr )

virtual

Add a new constraint to the engine.

Implements Minotaur::Engine.

◆ changeBound() [1/3]

void CbcEngine::changeBound	(	ConstraintPtr	cons,
		BoundType	lu,
		double	new_val
	)

virtual

Change a bound of a constraint.

Implements Minotaur::Engine.

◆ changeBound() [2/3]

void CbcEngine::changeBound	(	VariablePtr	var,
		BoundType	lu,
		double	new_val
	)

virtual

Change a bound of a variable.

Implements Minotaur::Engine.

◆ changeBound() [3/3]

void CbcEngine::changeBound	(	VariablePtr	var,
		double	new_lb,
		double	new_ub
	)

virtual

Change both bounds of a variable.

Implements Minotaur::Engine.

◆ changeConstraint() [1/2]

void CbcEngine::changeConstraint	(	ConstraintPtr	c,
		NonlinearFunctionPtr	nlf
	)

virtual

Change the nonlinear function, and the bounds of a constraint.

Parameters

[in]	c	Original constraint that is to be changed.
	[nlf]	The new nonlinear function.

Implements Minotaur::Engine.

◆ changeConstraint() [2/2]

void CbcEngine::changeConstraint	(	ConstraintPtr	c,
		LinearFunctionPtr	lf,
		double	lb,
		double	ub
	)

virtual

Change the linear function, and the bounds of a constraint.

Parameters

[in]	c	Original constraint that is to be changed.
	[lf]	The new linear function.
	[lb]	The new lower bound.
	[ub]	The new upper bound.

Implements Minotaur::Engine.

◆ changeObj()

void CbcEngine::changeObj	(	FunctionPtr	f,
		double	cb
	)

virtual

Change objective function.

Implements Minotaur::Engine.

◆ clear()

void CbcEngine::clear ( )

virtual

Clear the problem.

Implements Minotaur::Engine.

◆ disableStrBrSetup()

void Minotaur::CbcEngine::disableStrBrSetup ( )

inlinevirtual

Restore settings after strong branching.

Implements Minotaur::Engine.

◆ emptyCopy()

EnginePtr CbcEngine::emptyCopy ( )

virtual

Return an empty CbcEngine pointer.

Reimplemented from Minotaur::Engine.

◆ enableStrBrSetup()

void Minotaur::CbcEngine::enableStrBrSetup ( )

inlinevirtual

Make settings for strong branching.

Implements Minotaur::Engine.

◆ getName()

std::string CbcEngine::getName ( ) const

virtual

Get the name.

Implements Minotaur::Engine.

◆ getNumSols()

UInt Minotaur::CbcEngine::getNumSols ( )

inlinevirtual

Get the number of solutions in the solution pool of Cbc.

Implements Minotaur::MILPEngine.

◆ getSolution()

ConstSolutionPtr CbcEngine::getSolution ( )

virtual

Get the solution obtained after solving the problem.

Implements Minotaur::Engine.

◆ getSolutionFromPool()

ConstSolutionPtr Minotaur::CbcEngine::getSolutionFromPool ( int )

inlinevirtual

Get a particular solution from solution pool.

Implements Minotaur::MILPEngine.

◆ getSolutionValue()

double CbcEngine::getSolutionValue ( )

virtual

Return the solution value of the objective after solving the LP.

Implements Minotaur::Engine.

◆ getStatus()

EngineStatus CbcEngine::getStatus ( )

virtual

Get the status of the last solve command.

Implements Minotaur::Engine.

◆ getWarmStart()

ConstWarmStartPtr Minotaur::CbcEngine::getWarmStart ( )

inlinevirtual

Get warm start information from the engine. This warm start information can change if the engine is used to solve something else again.

Implements Minotaur::Engine.

◆ getWarmStartCopy()

WarmStartPtr Minotaur::CbcEngine::getWarmStartCopy ( )

inlinevirtual

Get a full copy of warm start information from the engine. Does not change even if the engine starts solving something else later on.

Implements Minotaur::Engine.

◆ load()

void CbcEngine::load ( ProblemPtr problem )

virtual

Load the problem into the engine. We create arrays of variables and constraints, the A matrix, rhs, objective etc from the problem and initialize the LP solver.

Implements Minotaur::Engine.

◆ loadFromWarmStart()

void Minotaur::CbcEngine::loadFromWarmStart ( const ws )

inlinevirtual

Use warm start information for solving the next problem. May Create a copy of WarmStart and use the copy inside the engine; the copy (but not the original) gets updated after solving a relaxation.

Implements Minotaur::Engine.

◆ negateObj()

void CbcEngine::negateObj ( )

virtual

Negate the objective function. Min f is changed to Min -f.

Implements Minotaur::Engine.

◆ removeCons()

void CbcEngine::removeCons ( std::vector< ConstraintPtr > & delcons )

virtual

Delete constraints from the engine.

Parameters

[in] delcons A vector of constraint pointers that should be deleted from the engine.

Implements Minotaur::Engine.

◆ resetIterationLimit()

void CbcEngine::resetIterationLimit ( )

virtual

Reset the iteration limit to maximum possible.

Implements Minotaur::Engine.

◆ setDualObjLimit()

int Minotaur::CbcEngine::setDualObjLimit ( double )

inlinevirtual

Set the dual objective limit.

Implements Minotaur::Engine.

◆ setIterationLimit()

void CbcEngine::setIterationLimit ( int limit )

virtual

Set a limit on number of iterations. For strong-branching, for instance.

Implements Minotaur::Engine.

◆ setTimeLimit()

void CbcEngine::setTimeLimit ( double )

virtual

Set time limit for an iteration.

Implements Minotaur::MILPEngine.

◆ setUpperCutoff()

void CbcEngine::setUpperCutoff ( double )

virtual

Set upper cutoff for an iteration.

Implements Minotaur::MILPEngine.

◆ solve()

EngineStatus CbcEngine::solve ( )

virtual

Solve the problem that was loaded. Calls resolve() function of Osi. The resolve() function `‘smartly’' decides what method of clp should be called.

Implements Minotaur::Engine.

◆ writeStats()

void CbcEngine::writeStats ( std::ostream & out ) const

virtual

Write statistics.

Reimplemented from Minotaur::Engine.

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

/home/amahajan/tmp/minotaur-test/src/interfaces/CbcEngine.h
/home/amahajan/tmp/minotaur-test/src/interfaces/CbcEngine.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addConstraint()

◆ changeBound() [1/3]

◆ changeBound() [2/3]

◆ changeBound() [3/3]

◆ changeConstraint() [1/2]

◆ changeConstraint() [2/2]

◆ changeObj()

◆ clear()

◆ disableStrBrSetup()

◆ emptyCopy()

◆ enableStrBrSetup()

◆ getName()

◆ getNumSols()

◆ getSolution()

◆ getSolutionFromPool()

◆ getSolutionValue()

◆ getStatus()

◆ getWarmStart()

◆ getWarmStartCopy()

◆ load()

◆ loadFromWarmStart()

◆ negateObj()

◆ removeCons()

◆ resetIterationLimit()

◆ setDualObjLimit()

◆ setIterationLimit()

◆ setTimeLimit()

◆ setUpperCutoff()

◆ solve()

◆ writeStats()