Couenne::CouenneUserInterface Class Reference

#include <CouenneUserInterface.hpp>

Inheritance diagram for Couenne::CouenneUserInterface:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 CouenneUserInterface (Ipopt::SmartPtr< Ipopt::OptionsList > options_, Ipopt::SmartPtr< Ipopt::Journalist > jnlst_)
virtual ~CouenneUserInterface ()
virtual bool setupJournals ()
 Setup journals for printing.
virtual CouenneProblemgetCouenneProblem ()=0
 Should return the problem to solve in algebraic form.
virtual Ipopt::SmartPtr< Bonmin::TMINLPgetTMINLP ()=0
 Should return the problem to solve as TMINLP.
virtual bool addBabPlugins (Bonmin::Bab &bab)
 Called after B&B object is setup.
virtual bool writeSolution (Bonmin::Bab &bab)
 Called after B&B finished.

Protected Attributes

Ipopt::SmartPtr< Ipopt::OptionsList > options
Ipopt::SmartPtr< Ipopt::Journalist > jnlst

Detailed Description

Definition at line 32 of file CouenneUserInterface.hpp.


Constructor & Destructor Documentation

Couenne::CouenneUserInterface::CouenneUserInterface ( Ipopt::SmartPtr< Ipopt::OptionsList >  options_,
Ipopt::SmartPtr< Ipopt::Journalist >  jnlst_ 
) [inline]

Definition at line 38 of file CouenneUserInterface.hpp.

virtual Couenne::CouenneUserInterface::~CouenneUserInterface (  )  [inline, virtual]

Definition at line 42 of file CouenneUserInterface.hpp.


Member Function Documentation

virtual bool Couenne::CouenneUserInterface::setupJournals (  )  [inline, virtual]

Setup journals for printing.

Default is to have one journal that prints to stdout.

Definition at line 47 of file CouenneUserInterface.hpp.

References jnlst.

Referenced by main().

virtual CouenneProblem* Couenne::CouenneUserInterface::getCouenneProblem (  )  [pure virtual]

Should return the problem to solve in algebraic form.

NOTE: Couenne is (currently) going to modify this problem!

Implemented in Couenne::CouenneOSInterface, and Couenne::CouenneAmplInterface.

Referenced by main().

virtual Ipopt::SmartPtr<Bonmin::TMINLP> Couenne::CouenneUserInterface::getTMINLP (  )  [pure virtual]

Should return the problem to solve as TMINLP.

Implemented in Couenne::CouenneOSInterface, and Couenne::CouenneAmplInterface.

Referenced by main().

virtual bool Couenne::CouenneUserInterface::addBabPlugins ( Bonmin::Bab bab  )  [inline, virtual]

Called after B&B object is setup.

User should add plugins like cut generators, bound tighteners, or heuristics here.

Definition at line 65 of file CouenneUserInterface.hpp.

Referenced by main().

virtual bool Couenne::CouenneUserInterface::writeSolution ( Bonmin::Bab bab  )  [inline, virtual]

Called after B&B finished.

Should write solution information.

Reimplemented in Couenne::CouenneOSInterface, and Couenne::CouenneAmplInterface.

Definition at line 79 of file CouenneUserInterface.hpp.

Referenced by main().


Member Data Documentation

Ipopt::SmartPtr<Ipopt::OptionsList> Couenne::CouenneUserInterface::options [protected]

Definition at line 34 of file CouenneUserInterface.hpp.

Referenced by Couenne::CouenneAmplInterface::getTMINLP(), Couenne::CouenneAmplInterface::readASLfg(), and Couenne::CouenneAmplInterface::readnl().

Ipopt::SmartPtr<Ipopt::Journalist> Couenne::CouenneUserInterface::jnlst [protected]

Definition at line 35 of file CouenneUserInterface.hpp.

Referenced by Couenne::CouenneAmplInterface::getTMINLP(), Couenne::CouenneAmplInterface::nl2e(), Couenne::CouenneAmplInterface::readnl(), and setupJournals().


The documentation for this class was generated from the following file:
Generated on Wed Nov 30 03:13:28 2011 by  doxygen 1.4.7