Bonmin::CouenneSetup Class Reference

#include <BonCouenneSetup.hpp>

Collaboration diagram for Bonmin::CouenneSetup:

[legend]List of all members.

Public Member Functions
	CouenneSetup ()
	Default constructor.
	CouenneSetup (const CouenneSetup &other)
	Copy constructor.
virtual BabSetupBase *	clone () const
	virtual copy constructor.
virtual	~CouenneSetup ()
	destructor
bool	InitializeCouenne (char **argv=NULL, CouenneProblem *couenneProb=NULL, Ipopt::SmartPtr< Bonmin::TMINLP > tminlp=NULL, CouenneInterface *ci=NULL)
	Initialize from command line arguments.
bool	InitializeCouenne (char **argv=NULL, CouenneProblem *couenneProb=NULL, CouenneInterface *ci=NULL)
	Initialize from command line arguments.
virtual void	registerOptions ()
	register the options
virtual void	readOptionsFile ()
	Get the basic options if don't already have them.
CouenneCutGenerator *	couennePtr () const
	return pointer to cut generator (used to get pointer to problem)
bool	displayStats ()
	true if one wants to display statistics at the end of program
void	addMilpCutGenerators ()
	add cut generators
void	setDoubleParameter (const DoubleParameter &p, const double val)
	modify parameter (used for MaxTime)
double	getDoubleParameter (const DoubleParameter &p) const
	modify parameter (used for MaxTime)
Static Public Member Functions
static void	registerAllOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
	Register all Couenne options.
Private Attributes
SmartPtr< SmartAsl >	aslfg_
CouenneCutGenerator *	CouennePtr_
	hold a reference to Couenne cut generator to delete it at last.
bool	displayStats_
	true if one wants to display statistics at the end of program
CouenneProblem *	couenneProb_
	MINLP formulation.
bool	couenneProb_is_own_
	whether the couenneProb_ has been created by Couenne, and thus will be deleted by Couenne

---

Detailed Description

Definition at line 34 of file BonCouenneSetup.hpp.

---

Constructor & Destructor Documentation

Bonmin::CouenneSetup::CouenneSetup

(

)

[inline]

Default constructor.

Definition at line 37 of file BonCouenneSetup.hpp.

Referenced by clone().

Bonmin::CouenneSetup::CouenneSetup

(

const CouenneSetup &

other

)

[inline]

Copy constructor.

Definition at line 46 of file BonCouenneSetup.hpp.

virtual Bonmin::CouenneSetup::~CouenneSetup

(

)

[virtual]

destructor

---

Member Function Documentation

virtual BabSetupBase* Bonmin::CouenneSetup::clone

(

)

const [inline, virtual]

virtual copy constructor.

Definition at line 53 of file BonCouenneSetup.hpp.

References CouenneSetup().

bool Bonmin::CouenneSetup::InitializeCouenne	(	char **	argv = NULL,
		CouenneProblem *	couenneProb = NULL,
		Ipopt::SmartPtr< Bonmin::TMINLP >	tminlp = NULL,
		CouenneInterface *	ci = NULL
	)

Initialize from command line arguments.

bool Bonmin::CouenneSetup::InitializeCouenne	(	char **	argv = NULL,
		CouenneProblem *	couenneProb = NULL,
		CouenneInterface *	ci = NULL
	)

Initialize from command line arguments.

This function is DEPRECATED and may be removed in future versions.

virtual void Bonmin::CouenneSetup::registerOptions

(

)

[virtual]

register the options

static void Bonmin::CouenneSetup::registerAllOptions

(

Ipopt::SmartPtr< Bonmin::RegisteredOptions >

roptions

)

[static]

Register all Couenne options.

virtual void Bonmin::CouenneSetup::readOptionsFile

(

)

[inline, virtual]

Get the basic options if don't already have them.

Definition at line 77 of file BonCouenneSetup.hpp.

CouenneCutGenerator* Bonmin::CouenneSetup::couennePtr

(

)

const [inline]

return pointer to cut generator (used to get pointer to problem)

Definition at line 83 of file BonCouenneSetup.hpp.

References CouennePtr_.

bool Bonmin::CouenneSetup::displayStats

(

)

[inline]

true if one wants to display statistics at the end of program

Definition at line 87 of file BonCouenneSetup.hpp.

References displayStats_.

void Bonmin::CouenneSetup::addMilpCutGenerators

(

)

add cut generators

void Bonmin::CouenneSetup::setDoubleParameter	(	const DoubleParameter &	p,
		const double	val
	)			[inline]

modify parameter (used for MaxTime)

Definition at line 94 of file BonCouenneSetup.hpp.

double Bonmin::CouenneSetup::getDoubleParameter

(

const DoubleParameter &

p

)

const [inline]

modify parameter (used for MaxTime)

Definition at line 98 of file BonCouenneSetup.hpp.

---

Member Data Documentation

SmartPtr<SmartAsl> Bonmin::CouenneSetup::aslfg_ [private]

Definition at line 102 of file BonCouenneSetup.hpp.

CouenneCutGenerator* Bonmin::CouenneSetup::CouennePtr_ [private]

hold a reference to Couenne cut generator to delete it at last.

The alternative would be to clone it every time the CouenneSolverInterface is cloned (that is, at each call of Optimality-based bound tightening).

Definition at line 108 of file BonCouenneSetup.hpp.

Referenced by couennePtr().

bool Bonmin::CouenneSetup::displayStats_ [private]

true if one wants to display statistics at the end of program

Definition at line 111 of file BonCouenneSetup.hpp.

Referenced by displayStats().

CouenneProblem* Bonmin::CouenneSetup::couenneProb_ [private]

MINLP formulation.

Definition at line 114 of file BonCouenneSetup.hpp.

bool Bonmin::CouenneSetup::couenneProb_is_own_ [private]

whether the couenneProb_ has been created by Couenne, and thus will be deleted by Couenne

Definition at line 117 of file BonCouenneSetup.hpp.

---

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

• BonCouenneSetup.hpp

---