OS  2.10.1
Public Member Functions | Public Attributes | List of all members
IpoptSolver Class Reference

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

#include <OSIpoptSolver.h>

+ Inheritance diagram for IpoptSolver:
+ Collaboration diagram for IpoptSolver:

Public Member Functions

 IpoptSolver ()
 the IpoptSolver class constructor More...
 
 ~IpoptSolver ()
 the IpoptSolver class destructor More...
 
virtual void solve () throw (ErrorClass)
 solve results in an instance being read into the Ipopt data structures and optimize More...
 
virtual void buildSolverInstance () throw (ErrorClass)
 The implementation of the virtual functions. 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...
 
- Public Member Functions inherited from DefaultSolver
 DefaultSolver ()
 default constructor. More...
 
virtual ~DefaultSolver ()=0
 default destructor. More...
 

Public Attributes

Ipopt::SmartPtr< Ipopt::TNLP > nlp
 
Ipopt::SmartPtr< Ipopt::IpoptApplication > app
 
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...
 

Detailed Description

The IpoptSolver class solves problems using Ipopt.

Author
Robert Fourer, Jun Ma, Kipp Martin
Version
1.0, 03/14/2004
Since
OS 1.0
Remarks
this class takes an OSiL instance and optimizes it using the COIN-OR Ipopt solver

Definition at line 167 of file OSIpoptSolver.h.

Constructor & Destructor Documentation

◆ IpoptSolver()

IpoptSolver::IpoptSolver ( )

the IpoptSolver class constructor

◆ ~IpoptSolver()

IpoptSolver::~IpoptSolver ( )

the IpoptSolver class destructor

Member Function Documentation

◆ solve()

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

solve results in an instance being read into the Ipopt data structures and optimize

Implements DefaultSolver.

◆ buildSolverInstance()

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

The implementation of the virtual functions.

Returns
void.

Implements DefaultSolver.

◆ setSolverOptions()

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

The implementation of the virtual functions.

Returns
void.

Implements DefaultSolver.

◆ dataEchoCheck()

void IpoptSolver::dataEchoCheck ( )

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

Member Data Documentation

◆ nlp

Ipopt::SmartPtr<Ipopt::TNLP> IpoptSolver::nlp

Definition at line 177 of file OSIpoptSolver.h.

◆ app

Ipopt::SmartPtr<Ipopt::IpoptApplication> IpoptSolver::app

Definition at line 179 of file OSIpoptSolver.h.

◆ m_osilreader

OSiLReader* IpoptSolver::m_osilreader

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

Definition at line 209 of file OSIpoptSolver.h.

◆ m_osolreader

OSoLReader* IpoptSolver::m_osolreader

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

Definition at line 215 of file OSIpoptSolver.h.


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