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]

List of all members.

Public Member Functions

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

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

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, Guss 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 62 of file OSCouenneSolver.h.


Constructor & Destructor Documentation

CouenneSolver::CouenneSolver (  ) 

the CouenneSolver class constructor

Definition at line 97 of file OSCouenneSolver.cpp.

CouenneSolver::~CouenneSolver (  ) 

the IpoptSolver class destructor

delete couenne;

Definition at line 110 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 571 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 152 of file OSCouenneSolver.cpp.

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

The implementation of the virtual functions.

Returns:
void.

Implements DefaultSolver.

Definition at line 468 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 777 of file OSCouenneSolver.cpp.

expression * CouenneSolver::createCouenneExpression ( OSnLNode node  )  [private]

Definition at line 335 of file OSCouenneSolver.cpp.


Member Data Documentation

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

Definition at line 105 of file OSCouenneSolver.h.

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

Definition at line 111 of file OSCouenneSolver.h.

Definition at line 113 of file OSCouenneSolver.h.

Definition at line 115 of file OSCouenneSolver.h.

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

Definition at line 117 of file OSCouenneSolver.h.

Definition at line 122 of file OSCouenneSolver.h.

Bonmin::TMINLP::SolverReturn CouenneSolver::status

Definition at line 124 of file OSCouenneSolver.h.

Definition at line 126 of file OSCouenneSolver.h.

Definition at line 127 of file OSCouenneSolver.h.

Definition at line 130 of file OSCouenneSolver.h.

Definition at line 132 of file OSCouenneSolver.h.

std::string CouenneSolver::couenneErrorMsg [private]

Definition at line 133 of file OSCouenneSolver.h.


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

Generated on 22 May 2012 by  doxygen 1.6.1