The CplexLPEngine class can be called to solve LP problems. More...

#include <CplexLPEngine.h>

Inheritance diagram for Minotaur::CplexLPEngine:

[legend]

Collaboration diagram for Minotaur::CplexLPEngine:

[legend]

Public Member Functions
void	doNothing ()

	CplexLPEngine (EnvPtr env)
	Constructor with an environment.

	~CplexLPEngine ()
	Destroy.

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

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

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

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

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

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

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

void	clear ()
	Clear the problem.

void	disableStrBrSetup ()
	Restore settings after strong branching.

EnginePtr	emptyCopy ()
	Return an empty CplexLPEngine pointer.

void	enableStrBrSetup ()
	Make settings for strong branching.

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

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

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

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

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

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.

void	printx (double *, UInt)

void	printx (const int *, UInt)

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

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

void	setIterationLimit (int)

int	setDualObjLimit (double)
	Set the dual objective limit.

void	setTimeLimit (double)

EngineStatus	solve ()
	Solve the problem that was loaded previously.

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

void	writeLP ()
	Writes an LP file in the directory of problem file.

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

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

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

virtual void	enableFactorization ()

virtual void	disableFactorization ()

virtual bool	IsOptimalBasisAvailable ()

virtual void	getBasics (int *)

virtual void	getBInvARow (int, double , double )

virtual int	getNumCols ()

virtual int	getNumRows ()

virtual const double *	getColLower ()

virtual const double *	getColUpper ()

virtual const double *	getRowLower ()

virtual const double *	getRowUpper ()

virtual const double *	getRightHandSide ()

virtual const double *	getRowActivity ()

virtual const double *	getOriginalTableau ()

virtual const int *	getRowStarts ()

virtual const int *	getIndicesofVars ()

virtual const int *	getRowLength ()

virtual void	loadDualWarmStart (int, double *)

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

virtual	~Engine ()
	Destroy.

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

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

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.

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

LoggerPtr	logger_
	Keep log.

Detailed Description

The CplexLPEngine class can be called to solve LP problems.

Member Function Documentation

◆ addConstraint()

void CplexLPEngine::addConstraint ( ConstraintPtr )

virtual

Add a new constraint to the engine.

Implements Minotaur::Engine.

◆ changeBound() [1/3]

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

virtual

Change a bound of a constraint.

Implements Minotaur::Engine.

◆ changeBound() [2/3]

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

virtual

Change a bound of a variable.

Implements Minotaur::Engine.

◆ changeBound() [3/3]

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

virtual

Change both bounds of a variable.

Implements Minotaur::Engine.

◆ changeConstraint() [1/2]

void CplexLPEngine::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 CplexLPEngine::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 CplexLPEngine::changeObj	(	FunctionPtr	f,
		double	cb
	)

virtual

Change objective function.

Implements Minotaur::Engine.

◆ clear()

void CplexLPEngine::clear ( )

virtual

Clear the problem.

Implements Minotaur::Engine.

◆ disableStrBrSetup()

void CplexLPEngine::disableStrBrSetup ( )

virtual

Restore settings after strong branching.

Implements Minotaur::Engine.

◆ emptyCopy()

EnginePtr CplexLPEngine::emptyCopy ( )

virtual

Return an empty CplexLPEngine pointer.

Reimplemented from Minotaur::Engine.

◆ enableStrBrSetup()

void CplexLPEngine::enableStrBrSetup ( )

virtual

Make settings for strong branching.

Implements Minotaur::Engine.

◆ fillStats()

void CplexLPEngine::fillStats ( std::vector< double > & )

virtual

Accumulate statistics from different threads in a common data.

Reimplemented from Minotaur::Engine.

◆ getName()

std::string CplexLPEngine::getName ( ) const

virtual

Get the name.

Implements Minotaur::Engine.

◆ getSolution()

ConstSolutionPtr CplexLPEngine::getSolution ( )

virtual

Get the solution obtained after solving the problem.

Implements Minotaur::Engine.

◆ getSolutionValue()

double CplexLPEngine::getSolutionValue ( )

virtual

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

Implements Minotaur::Engine.

◆ getStatus()

EngineStatus CplexLPEngine::getStatus ( )

virtual

Get the status of the last solve command.

Implements Minotaur::Engine.

◆ getWarmStart()

ConstWarmStartPtr Minotaur::CplexLPEngine::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 CplexLPEngine::getWarmStartCopy ( )

virtual

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 CplexLPEngine::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::CplexLPEngine::loadFromWarmStart ( const WarmStartPtr 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 CplexLPEngine::negateObj ( )

virtual

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

Implements Minotaur::Engine.

◆ removeCons()

void CplexLPEngine::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 CplexLPEngine::resetIterationLimit ( )

virtual

Reset the iteration limit to maximum possible.

Implements Minotaur::Engine.

◆ setDualObjLimit()

int CplexLPEngine::setDualObjLimit ( double )

virtual

Set the dual objective limit.

Implements Minotaur::Engine.

◆ setIterationLimit()

void CplexLPEngine::setIterationLimit ( int limit )

virtual

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

Implements Minotaur::Engine.

◆ solve()

EngineStatus CplexLPEngine::solve ( )

virtual

Solve the problem that was loaded previously.

Implements Minotaur::Engine.

◆ writeStats()

void CplexLPEngine::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/CplexLPEngine.h
/home/amahajan/tmp/minotaur-test/src/interfaces/CplexLPEngine.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()

◆ fillStats()

◆ getName()

◆ getSolution()

◆ getSolutionValue()

◆ getStatus()

◆ getWarmStart()

◆ getWarmStartCopy()

◆ load()

◆ loadFromWarmStart()

◆ negateObj()

◆ removeCons()

◆ resetIterationLimit()

◆ setDualObjLimit()

◆ setIterationLimit()

◆ solve()

◆ writeStats()