Public Member Functions | Public Attributes | Private Attributes | List of all members
BonminSolver Class Reference

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

#include <OSBonminSolver.h>

Inheritance diagram for BonminSolver:
Inheritance graph
[legend]
Collaboration diagram for BonminSolver:
Collaboration graph
[legend]

Public Member Functions

 BonminSolver ()
 the BonminSolver class constructor More...
 
 ~BonminSolver ()
 the IpoptSolver class destructor More...
 
virtual void solve () throw (ErrorClass)
 solve results in an instance being read into the Bonmin data structrues and optimized More...
 
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 More...
 
virtual void setSolverOptions () throw (ErrorClass)
 The implementation of the virtual functions. More...
 
void dataEchoCheck ()
 use this for debugging, print out the instance that the solver thinks it has and compare this with the OSiL file More...
 
void writeResult ()
 use this to write the solution information to an OSResult object More...
 
- Public Member Functions inherited from DefaultSolver
 DefaultSolver ()
 default constructor. More...
 
virtual ~DefaultSolver ()=0
 default destructor. More...
 

Public Attributes

Ipopt::SmartPtr< BonminProblemtminlp
 
Bonmin::Bab bb
 
Bonmin::TMINLP::SolverReturn status
 
OSiLReaderm_osilreader
 m_osilreader is an OSiLReader object used to create an osinstance from an osil string if needed More...
 
OSoLReaderm_osolreader
 m_osolreader is an OSoLReader object used to create an osoption from an osol string if needed More...
 
- Public Attributes inherited from DefaultSolver
std::string osil
 osil holds the problem instance as a std::string More...
 
std::string osol
 osol holds the options for the solver More...
 
std::string osrl
 osrl holds the solution or result of the model More...
 
OSInstanceosinstance
 osinstance holds the problem instance in-memory as an OSInstance object More...
 
OSOptionosoption
 osoption holds the solver options in-memory as an OSOption object More...
 
OSResultosresult
 osresult holds the solution or result of the model in-memory as an OSResult object More...
 
std::string sSolverName
 sSolverName is the name of the Coin solver used, e.g. More...
 
bool bCallbuildSolverInstance
 bCallbuildSolverInstance is set to true if buildSolverService has been called More...
 
bool bSetSolverOptions
 bSetSolverOptions is set to true if setSolverOptions has been called, false otherwise More...
 

Private Attributes

OSrLWriterosrlwriter
 
Bonmin::BonminSetup bonminSetup
 
std::string bonminErrorMsg
 

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

the BonminSolver class constructor

Definition at line 36 of file OSBonminSolver.cpp.

BonminSolver::~BonminSolver ( )

the IpoptSolver class destructor

Definition at line 45 of file OSBonminSolver.cpp.

Member Function Documentation

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

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

Implements DefaultSolver.

Definition at line 841 of file OSBonminSolver.cpp.

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.

Definition at line 660 of file OSBonminSolver.cpp.

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

The implementation of the virtual functions.

Returns
void.

Implements DefaultSolver.

Definition at line 693 of file OSBonminSolver.cpp.

void BonminSolver::dataEchoCheck ( )

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

Definition at line 1079 of file OSBonminSolver.cpp.

void BonminSolver::writeResult ( )

use this to write the solution information to an OSResult object

Definition at line 954 of file OSBonminSolver.cpp.

Member Data Documentation

Ipopt::SmartPtr<BonminProblem> BonminSolver::tminlp

Definition at line 239 of file OSBonminSolver.h.

Bonmin::Bab BonminSolver::bb

Definition at line 242 of file OSBonminSolver.h.

Bonmin::TMINLP::SolverReturn BonminSolver::status

Definition at line 244 of file OSBonminSolver.h.

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.

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.

OSrLWriter* BonminSolver::osrlwriter
private

Definition at line 294 of file OSBonminSolver.h.

Bonmin::BonminSetup BonminSolver::bonminSetup
private

Definition at line 296 of file OSBonminSolver.h.

std::string BonminSolver::bonminErrorMsg
private

Definition at line 298 of file OSBonminSolver.h.


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