BonminSolver Class Reference

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

#include <OSBonminSolver.h>

Inheritance diagram for BonminSolver:

Collaboration diagram for BonminSolver:

Public Member Functions
	BonminSolver ()
	the BonminSolver class constructor
	~BonminSolver ()
	the IpoptSolver class destructor
virtual void	solve () throw (ErrorClass)
	solve results in an instance being read into the Bonmin data structrues and optimized
virtual void	buildSolverInstance () throw (ErrorClass)
	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 () 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
void	writeResult ()
	use this to write the solution information to an OSResult object
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< BonminProblem >	tminlp
Bonmin::Bab	bb
Bonmin::TMINLP::SolverReturn	status
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 BonminSolver class solves problems using Ipopt.

Author

Jun Ma, Horand Gassmann, Kipp Martin

Version

1.0, 07/05/2008

Since

OS 1.0

Remarks

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

Definition at line 225 of file OSBonminSolver.h.

Constructor & Destructor Documentation

BonminSolver()

BonminSolver::BonminSolver

(

)

the BonminSolver class constructor

~BonminSolver()

BonminSolver::~BonminSolver

(

)

the IpoptSolver class destructor

Member Function Documentation

solve()

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

virtual

solve results in an instance being read into the Bonmin data structrues and optimized

Implements DefaultSolver.

buildSolverInstance()

virtual void BonminSolver::buildSolverInstance ( ) throw ( ErrorClass )

virtual

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

Implements DefaultSolver.

setSolverOptions()

void BonminSolver::setSolverOptions ( ) throw ( ErrorClass )

virtual

The implementation of the virtual functions.

Returns

void.

Implements DefaultSolver.

dataEchoCheck()

void BonminSolver::dataEchoCheck

(

)

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

writeResult()

void BonminSolver::writeResult

(

)

use this to write the solution information to an OSResult object

Member Data Documentation

tminlp

Ipopt::SmartPtr<BonminProblem> BonminSolver::tminlp

Definition at line 239 of file OSBonminSolver.h.

bb

Bonmin::Bab BonminSolver::bb

Definition at line 242 of file OSBonminSolver.h.

status

Bonmin::TMINLP::SolverReturn BonminSolver::status

Definition at line 244 of file OSBonminSolver.h.

m_osilreader

OSiLReader* BonminSolver::m_osilreader

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

Definition at line 276 of file OSBonminSolver.h.

m_osolreader

OSoLReader* BonminSolver::m_osolreader

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

Definition at line 282 of file OSBonminSolver.h.

---

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

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