Inheritance diagram for Minotaur::IpoptEngine:

Collaboration diagram for Minotaur::IpoptEngine:

[legend]

Public Member Functions
	IpoptEngine (EnvPtr env)
	Default constructor.

	~IpoptEngine ()
	Destroy.

void	addConstraint (ConstraintPtr c)
	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, NonlinearFunctionPtr)
	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 loaded problem, if any, from the engine. More...

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

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

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

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

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

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

double	getSolutionValue ()
	Get the solution value. More...

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

ConstWarmStartPtr	getWarmStart ()

WarmStartPtr	getWarmStartCopy ()

void	load (ProblemPtr problem)
	Load the problem into IPOPT. We create the TNLP interface to IPOPT. More...

void	loadFromWarmStart (const WarmStartPtr ws)

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	setOptionsForSingleSolve ()

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

EngineStatus	solve ()

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

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

virtual	~NLPEngine ()
	Default destructor.

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

Friends
class	Problem

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

LoggerPtr	logger_
	Keep log.

Member Function Documentation

◆ addConstraint()

void Minotaur::IpoptEngine::addConstraint ( ConstraintPtr )

virtual

Add a new constraint to the engine.

Implements Minotaur::Engine.

◆ changeBound() [1/3]

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

virtual

Change a bound of a constraint.

Implements Minotaur::Engine.

◆ changeBound() [2/3]

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

virtual

Change a bound of a variable.

Implements Minotaur::Engine.

◆ changeBound() [3/3]

void Minotaur::IpoptEngine::changeBound	(	VariablePtr	var,
		double	new_lb,
		double	new_ub
	)

virtual

Change both bounds of a variable.

Implements Minotaur::Engine.

◆ changeConstraint() [1/2]

void Minotaur::IpoptEngine::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.

◆ changeConstraint() [2/2]

void Minotaur::IpoptEngine::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.

◆ changeObj()

void Minotaur::IpoptEngine::changeObj	(	FunctionPtr	f,
		double	cb
	)

virtual

Change objective function.

Implements Minotaur::Engine.

◆ clear()

void Minotaur::IpoptEngine::clear ( )

virtual

Clear the loaded problem, if any, from the engine.

Implements Minotaur::Engine.

◆ disableStrBrSetup()

void Minotaur::IpoptEngine::disableStrBrSetup ( )

virtual

Restore settings after strong branching.

Implements Minotaur::Engine.

◆ emptyCopy()

EnginePtr Minotaur::IpoptEngine::emptyCopy ( )

virtual

Return an empty IpoptEngine pointer.

Reimplemented from Minotaur::Engine.

◆ enableStrBrSetup()

void Minotaur::IpoptEngine::enableStrBrSetup ( )

virtual

Make settings for strong branching.

Implements Minotaur::Engine.

◆ fillStats()

void Minotaur::IpoptEngine::fillStats ( std::vector< double > & )

virtual

Accumulate statistics from different threads in a common data.

Reimplemented from Minotaur::Engine.

◆ getName()

std::string Minotaur::IpoptEngine::getName ( ) const

virtual

Get the name.

Implements Minotaur::Engine.

◆ getSolution()

ConstSolutionPtr Minotaur::IpoptEngine::getSolution ( )

virtual

Get the solution obtained after solving the problem.

Implements Minotaur::Engine.

◆ getSolutionValue()

double Minotaur::IpoptEngine::getSolutionValue ( )

virtual

Get the solution value.

Implements Minotaur::Engine.

◆ getStatus()

EngineStatus Minotaur::IpoptEngine::getStatus ( )

virtual

Get the status of the last solve command.

Implements Minotaur::Engine.

◆ getWarmStart()

ConstWarmStartPtr Minotaur::IpoptEngine::getWarmStart ( )

virtual

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::IpoptEngine::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 Minotaur::IpoptEngine::load ( ProblemPtr problem )

virtual

Load the problem into IPOPT. We create the TNLP interface to IPOPT.

Implements Minotaur::Engine.

◆ loadFromWarmStart()

void Minotaur::IpoptEngine::loadFromWarmStart ( const WarmStartPtr ws )

virtual

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 Minotaur::IpoptEngine::negateObj ( )

virtual

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

Implements Minotaur::Engine.

◆ removeCons()

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

virtual

Reset the iteration limit to maximum possible.

Implements Minotaur::Engine.

◆ setDualObjLimit()

int Minotaur::IpoptEngine::setDualObjLimit ( double )

inlinevirtual

Set the dual objective limit.

Implements Minotaur::Engine.

◆ setIterationLimit()

void Minotaur::IpoptEngine::setIterationLimit ( int limit )

virtual

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

Implements Minotaur::Engine.

◆ setOptionsForRepeatedSolve()

void Minotaur::IpoptEngine::setOptionsForRepeatedSolve ( )

virtual

Set options to solve the NLP repeatedly, with few changes.

Reimplemented from Minotaur::Engine.

◆ setOptionsForSingleSolve()

void Minotaur::IpoptEngine::setOptionsForSingleSolve ( )

virtual

Set options to solve the NLP only once or very few times, with possibly several changes.

Reimplemented from Minotaur::Engine.

◆ solve()

EngineStatus Minotaur::IpoptEngine::solve ( )

virtual

Solve the problem that was loaded. Uses the TNLP interface to IPOPT for solving the NLP.

Implements Minotaur::Engine.

◆ writeStats()

void Minotaur::IpoptEngine::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/IpoptEngine.h
/home/amahajan/tmp/minotaur-test/src/interfaces/IpoptEngine.cpp

Public Member Functions

Friends

Additional Inherited Members

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()

◆ setOptionsForRepeatedSolve()

◆ setOptionsForSingleSolve()

◆ solve()

◆ writeStats()