Couenne 0.5.8
Loading...
Searching...
No Matches
Couenne::CouenneUserInterface Class Referenceabstract

#include <CouenneUserInterface.hpp>

+ Inheritance diagram for Couenne::CouenneUserInterface:
+ Collaboration diagram for Couenne::CouenneUserInterface:

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::OptionsListoptions
 
Ipopt::SmartPtr< Ipopt::Journalistjnlst
 

Detailed Description

Definition at line 32 of file CouenneUserInterface.hpp.

Constructor & Destructor Documentation

◆ CouenneUserInterface()

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

Definition at line 38 of file CouenneUserInterface.hpp.

◆ ~CouenneUserInterface()

virtual Couenne::CouenneUserInterface::~CouenneUserInterface ( )
inlinevirtual

Definition at line 42 of file CouenneUserInterface.hpp.

Member Function Documentation

◆ setupJournals()

virtual bool Couenne::CouenneUserInterface::setupJournals ( )
inlinevirtual

Setup journals for printing.

Default is to have one journal that prints to stdout.

Definition at line 47 of file CouenneUserInterface.hpp.

◆ getCouenneProblem()

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::CouenneAmplInterface, and Couenne::CouenneOSInterface.

◆ getTMINLP()

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

Should return the problem to solve as TMINLP.

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

◆ addBabPlugins()

virtual bool Couenne::CouenneUserInterface::addBabPlugins ( Bonmin::Bab & bab)
inlinevirtual

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.

◆ writeSolution()

virtual bool Couenne::CouenneUserInterface::writeSolution ( Bonmin::Bab & bab)
inlinevirtual

Called after B&B finished.

Should write solution information.

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

Definition at line 79 of file CouenneUserInterface.hpp.

Member Data Documentation

◆ options

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

Definition at line 34 of file CouenneUserInterface.hpp.

◆ jnlst

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

Definition at line 35 of file CouenneUserInterface.hpp.


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