My Project
BonminSolver Class Reference

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

#include <OSBonminSolver.h>

Inheritance diagram for BonminSolver:
DefaultSolver

Public Member Functions

 BonminSolver ()
 the BonminSolver class constructor
 
 ~BonminSolver ()
 the IpoptSolver class destructor
 
virtual void solve ()
 solve results in an instance being read into the Bonmin data structrues and optimized
 
virtual void buildSolverInstance ()
 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 ()
 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
 DefaultSolver ()
 default constructor.
 
virtual ~DefaultSolver ()=0
 default destructor.
 

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
 
OSoLReaderm_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
 
OSInstanceosinstance
 osinstance holds the problem instance in-memory as an OSInstance object
 
OSOptionosoption
 osoption holds the solver options in-memory as an OSOption object
 
OSResultosresult
 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
 

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

the BonminSolver class constructor

Definition at line 36 of file OSBonminSolver.cpp.

◆ ~BonminSolver()

BonminSolver::~BonminSolver ( )

the IpoptSolver class destructor

Definition at line 45 of file OSBonminSolver.cpp.

Member Function Documentation

◆ solve()

void BonminSolver::solve ( )
virtual

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

Implements DefaultSolver.

Definition at line 840 of file OSBonminSolver.cpp.

◆ buildSolverInstance()

void BonminSolver::buildSolverInstance ( )
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.

◆ setSolverOptions()

void BonminSolver::setSolverOptions ( )
virtual

The implementation of the virtual functions.

Returns
void.

Implements DefaultSolver.

Definition at line 693 of file OSBonminSolver.cpp.

◆ 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

Definition at line 1078 of file OSBonminSolver.cpp.

◆ writeResult()

void BonminSolver::writeResult ( )

use this to write the solution information to an OSResult object

Definition at line 953 of file OSBonminSolver.cpp.

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.

◆ osrlwriter

OSrLWriter* BonminSolver::osrlwriter
private

Definition at line 294 of file OSBonminSolver.h.

◆ bonminSetup

Bonmin::BonminSetup BonminSolver::bonminSetup
private

Definition at line 296 of file OSBonminSolver.h.

◆ bonminErrorMsg

std::string BonminSolver::bonminErrorMsg
private

Definition at line 298 of file OSBonminSolver.h.


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