IpoptSolver Class Reference

The IpoptSolver class solves problems using Ipopt. More...

#include <OSIpoptSolver.h>

Inheritance diagram for IpoptSolver:

Collaboration diagram for IpoptSolver:

Public Member Functions
	IpoptSolver ()
	the IpoptSolver class constructor
	~IpoptSolver ()
	the IpoptSolver class destructor
virtual void	solve () throw (ErrorClass)
	solve results in an instance being read into the Ipopt data structures and optimize
virtual void	buildSolverInstance () throw (ErrorClass)
	The implementation of the virtual functions.
virtual void	setSolverOptions () throw (ErrorClass)
	The implementation of the virtual functions.
void	dataEchoCheck ()
	use this for debugging, print out the instance that the solver thinks it has and compare this with the OSiL file
Public Member Functions inherited from DefaultSolver
virtual void	solve ()=0
	solve is a virtual function – the actual solvers will implement their own solve method
virtual void	buildSolverInstance ()=0
	buildSolverInstance is a virtual function – the actual solvers will implement their own buildSolverInstance method – the solver instance is the instance the individual solver sees in its API
virtual void	setSolverOptions ()=0
	setSolverOptions is a virtual function – the actual solvers will implement their own setSolverOptions method – the solver options are the options the individual solver sees in its API
	DefaultSolver ()
	default constructor.
virtual	~DefaultSolver ()=0
	default destructor.

Public Attributes
Ipopt::SmartPtr< Ipopt::TNLP >	nlp
Ipopt::SmartPtr< Ipopt::IpoptApplication >	app
OSiLReader *	m_osilreader
	m_osilreader is an OSiLReader object used to create an osinstance from an osil string if needed
OSoLReader *	m_osolreader
	m_osolreader is an OSoLReader object used to create an osoption from an osol string if needed
Public Attributes inherited from DefaultSolver
std::string	osil
	osil holds the problem instance as a std::string
std::string	osol
	osol holds the options for the solver
std::string	osrl
	osrl holds the solution or result of the model
OSInstance *	osinstance
	osinstance holds the problem instance in-memory as an OSInstance object
OSOption *	osoption
	osoption holds the solver options in-memory as an OSOption object
OSResult *	osresult
	osresult holds the solution or result of the model in-memory as an OSResult object
std::string	sSolverName
	sSolverName is the name of the Coin solver used, e.g.
bool	bCallbuildSolverInstance
	bCallbuildSolverInstance is set to true if buildSolverService has been called
bool	bSetSolverOptions
	bSetSolverOptions is set to true if setSolverOptions has been called, false otherwise

Detailed Description

The IpoptSolver class solves problems using Ipopt.

Author

Robert Fourer, Jun Ma, Kipp Martin

Version

1.0, 03/14/2004

Since

OS 1.0

Remarks

this class takes an OSiL instance and optimizes it using the COIN-OR Ipopt solver

Definition at line 167 of file OSIpoptSolver.h.

Constructor & Destructor Documentation

IpoptSolver()

IpoptSolver::IpoptSolver

(

)

the IpoptSolver class constructor

~IpoptSolver()

IpoptSolver::~IpoptSolver

(

)

the IpoptSolver class destructor

Member Function Documentation

solve()

virtual void IpoptSolver::solve ( ) throw ( ErrorClass )

virtual

solve results in an instance being read into the Ipopt data structures and optimize

Implements DefaultSolver.

buildSolverInstance()

void IpoptSolver::buildSolverInstance ( ) throw ( ErrorClass )

virtual

The implementation of the virtual functions.

Returns

void.

Implements DefaultSolver.

setSolverOptions()

void IpoptSolver::setSolverOptions ( ) throw ( ErrorClass )

virtual

The implementation of the virtual functions.

Returns

void.

Implements DefaultSolver.

dataEchoCheck()

void IpoptSolver::dataEchoCheck

(

)

use this for debugging, print out the instance that the solver thinks it has and compare this with the OSiL file

Member Data Documentation

nlp

Ipopt::SmartPtr<Ipopt::TNLP> IpoptSolver::nlp

Definition at line 177 of file OSIpoptSolver.h.

app

Ipopt::SmartPtr<Ipopt::IpoptApplication> IpoptSolver::app

Definition at line 179 of file OSIpoptSolver.h.

m_osilreader

OSiLReader* IpoptSolver::m_osilreader

m_osilreader is an OSiLReader object used to create an osinstance from an osil string if needed

Definition at line 222 of file OSIpoptSolver.h.

m_osolreader

OSoLReader* IpoptSolver::m_osolreader

m_osolreader is an OSoLReader object used to create an osoption from an osol string if needed

Definition at line 228 of file OSIpoptSolver.h.

---

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

• /builddir/build/BUILD/OS-2.10.2/src/OSSolverInterfaces/OSIpoptSolver.h