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

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

#include <OSCouenneSolver.h>

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

Public Member Functions

 CouenneSolver ()
 the CouenneSolver class constructor More...
 
 ~CouenneSolver ()
 the IpoptSolver class destructor More...
 
virtual void solve () throw (ErrorClass)
 solve results in an instance being read into the Couenne 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

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...
 
Couenne::CouenneProblemcouenne
 
Ipopt::SmartPtr< BonminProblemtminlp
 
Ipopt::SmartPtr
< Bonmin::TNLPSolver
app_
 
Couenne::CouenneBab bb
 
Bonmin::TMINLP::SolverReturn status
 
Couenne::expressioncon_body
 
Couenne::expressionobj_body
 
- 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 Member Functions

Couenne::expressioncreateCouenneExpression (OSnLNode *node)
 

Private Attributes

OSrLWriterosrlwriter
 
Couenne::CouenneSetup couenneSetup
 
std::string couenneErrorMsg
 

Detailed Description

The CouenneSolver 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 67 of file OSCouenneSolver.h.

Constructor & Destructor Documentation

CouenneSolver::CouenneSolver ( )

the CouenneSolver class constructor

Definition at line 96 of file OSCouenneSolver.cpp.

CouenneSolver::~CouenneSolver ( )

the IpoptSolver class destructor

Definition at line 109 of file OSCouenneSolver.cpp.

Member Function Documentation

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

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

Implements DefaultSolver.

Definition at line 521 of file OSCouenneSolver.cpp.

void CouenneSolver::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 141 of file OSCouenneSolver.cpp.

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

The implementation of the virtual functions.

Returns
void.

Implements DefaultSolver.

Definition at line 441 of file OSCouenneSolver.cpp.

void CouenneSolver::dataEchoCheck ( )

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

void CouenneSolver::writeResult ( )

use this to write the solution information to an OSResult object

Definition at line 717 of file OSCouenneSolver.cpp.

expression * CouenneSolver::createCouenneExpression ( OSnLNode node)
private

Definition at line 316 of file OSCouenneSolver.cpp.

Member Data Documentation

OSiLReader* CouenneSolver::m_osilreader

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

Definition at line 110 of file OSCouenneSolver.h.

OSoLReader* CouenneSolver::m_osolreader

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

Definition at line 116 of file OSCouenneSolver.h.

Couenne::CouenneProblem* CouenneSolver::couenne

Definition at line 118 of file OSCouenneSolver.h.

Ipopt::SmartPtr<BonminProblem> CouenneSolver::tminlp

Definition at line 120 of file OSCouenneSolver.h.

Ipopt::SmartPtr<Bonmin::TNLPSolver> CouenneSolver::app_

Definition at line 122 of file OSCouenneSolver.h.

Couenne::CouenneBab CouenneSolver::bb

Definition at line 127 of file OSCouenneSolver.h.

Bonmin::TMINLP::SolverReturn CouenneSolver::status

Definition at line 129 of file OSCouenneSolver.h.

Couenne::expression* CouenneSolver::con_body

Definition at line 131 of file OSCouenneSolver.h.

Couenne::expression* CouenneSolver::obj_body

Definition at line 132 of file OSCouenneSolver.h.

OSrLWriter* CouenneSolver::osrlwriter
private

Definition at line 135 of file OSCouenneSolver.h.

Couenne::CouenneSetup CouenneSolver::couenneSetup
private

Definition at line 137 of file OSCouenneSolver.h.

std::string CouenneSolver::couenneErrorMsg
private

Definition at line 138 of file OSCouenneSolver.h.


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