Couenne 0.5.8
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
Couenne::CouenneSetup Class Reference

#include <BonCouenneSetup.hpp>

+ Inheritance diagram for Couenne::CouenneSetup:
+ Collaboration diagram for Couenne::CouenneSetup:

Public Member Functions

 CouenneSetup ()
 Default constructor.
 
 CouenneSetup (const CouenneSetup &other)
 Copy constructor.
 
virtual Bonmin::BabSetupBaseclone () const
 virtual copy constructor.
 
virtual ~CouenneSetup ()
 destructor
 
bool InitializeCouenne (char **argv=NULL, CouenneProblem *couenneProb=NULL, Ipopt::SmartPtr< Bonmin::TMINLP > tminlp=NULL, CouenneInterface *ci=NULL, Bonmin::Bab *bb=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.
 
CouenneCutGeneratorcouennePtr () 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)
 
void setNodeComparisonMethod (Bonmin::BabSetupBase::NodeComparison c)
 
- Public Member Functions inherited from Bonmin::BonminSetup
 BonminSetup (const CoinMessageHandler *handler=NULL)
 
 BonminSetup (const BonminSetup &other)
 
 BonminSetup (const BonminSetup &setup, OsiTMINLPInterface &nlp)
 
 BonminSetup (const BonminSetup &setup, OsiTMINLPInterface &nlp, const std::string &prefix)
 
BonminSetupclone (OsiTMINLPInterface &nlp) const
 
BonminSetupclone (OsiTMINLPInterface &nlp, const std::string &prefix) const
 
virtual ~BonminSetup ()
 
void initialize (Ipopt::SmartPtr< TMINLP > tminlp, bool createContinuousSolver=true)
 
void initialize (const OsiTMINLPInterface &nlpSi, bool createContinuousSolver=true)
 
Bonmin::Algorithm getAlgorithm ()
 
void addCutGenerator (CuttingMethod &cg)
 
virtual void setBabDefaultOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 
virtual void setBabDefaultOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 
- Public Member Functions inherited from Bonmin::BabSetupBase
void gatherParametersValues ()
 
void gatherParametersValues (Ipopt::SmartPtr< Ipopt::OptionsList > options)
 
Ipopt::SmartPtr< Ipopt::Journalistjournalist ()
 
Ipopt::SmartPtr< Ipopt::OptionsListoptions ()
 
Ipopt::SmartPtr< Bonmin::RegisteredOptionsroptions ()
 
const vector< OsiObject * > & objects () const
 
vector< OsiObject * > & objects ()
 
void addCutGenerator (CuttingMethod &cg)
 
void set_linearizer (TMINLP2OsiLP *linearizer)
 
void use (const OsiTMINLPInterface &nlp)
 
void use (Ipopt::SmartPtr< TMINLP > tminlp)
 
void use (Ipopt::SmartPtr< TMINLP2TNLP > prob)
 
void setNonlinearSolver (OsiTMINLPInterface *s)
 
OsiTMINLPInterfacenonlinearSolver ()
 
OsiSolverInterfacecontinuousSolver ()
 
CuttingMethodscutGenerators ()
 
HeuristicMethodsheuristics ()
 
OsiChooseVariablebranchingMethod ()
 
NodeComparisonnodeComparisonMethod ()
 
TreeTraversal treeTraversalMethod ()
 
int getIntParameter (const IntParameter &p) const
 
double getDoubleParameter (const DoubleParameter &p) const
 
void setIntParameter (const IntParameter &p, const int v)
 
void setDoubleParameter (const DoubleParameter &p, const double v)
 
 BabSetupBase (const CoinMessageHandler *handler=NULL)
 
 BabSetupBase (Ipopt::SmartPtr< TMINLP > tminlp, const CoinMessageHandler *handler=NULL)
 
 BabSetupBase (Ipopt::SmartPtr< TNLPSolver > app)
 
 BabSetupBase (const OsiTMINLPInterface &nlp)
 
 BabSetupBase (const BabSetupBase &setup, OsiTMINLPInterface &nlp)
 
 BabSetupBase (const BabSetupBase &setup, OsiTMINLPInterface &nlp, const std::string &prefix)
 
 BabSetupBase (const BabSetupBase &other)
 
virtual ~BabSetupBase ()
 
void use (const OsiTMINLPInterface &nlp)
 
void use (Ipopt::SmartPtr< TMINLP > tminlp)
 
void use (Ipopt::SmartPtr< TMINLP2TNLP > prob)
 
void setNonlinearSolver (OsiTMINLPInterface *s)
 
void readOptionsFile (std::string fileName)
 
void readOptionsString (std::string opt_string)
 
void readOptionsStream (std::istream &is)
 
void mayPrintDoc ()
 
const charprefix () const
 
void setOptionsAndJournalist (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions, Ipopt::SmartPtr< Ipopt::OptionsList > options, Ipopt::SmartPtr< Ipopt::Journalist > journalist)
 
void initializeOptionsAndJournalist ()
 
OsiTMINLPInterfacenonlinearSolver ()
 
OsiSolverInterfacecontinuousSolver ()
 
CuttingMethodscutGenerators ()
 
HeuristicMethodsheuristics ()
 
OsiChooseVariablebranchingMethod ()
 
NodeComparisonnodeComparisonMethod ()
 
TreeTraversal treeTraversalMethod ()
 
int getIntParameter (const IntParameter &p) const
 
double getDoubleParameter (const DoubleParameter &p) const
 
void setIntParameter (const IntParameter &p, const int v)
 
void setDoubleParameter (const DoubleParameter &p, const double v)
 

Static Public Member Functions

static void registerAllOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 Register all Couenne options.
 
- Static Public Member Functions inherited from Bonmin::BonminSetup
static void registerAllOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 
- Static Public Member Functions inherited from Bonmin::BabSetupBase
static void registerAllOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 

Additional Inherited Members

- Public Types inherited from Bonmin::BabSetupBase
enum  NodeComparison
 
enum  TreeTraversal
 
enum  VarSelectStra_Enum
 
enum  IntParameter
 
enum  DoubleParameter
 
typedef std::list< CuttingMethodCuttingMethods
 
typedef std::list< HeuristicMethodHeuristicMethods
 
- Public Attributes inherited from Bonmin::BabSetupBase
 bestBound
 
 DFS
 
 BFS
 
 dynamic
 
 bestGuess
 
 HeapOnly
 
 DiveFromBest
 
 ProbedDive
 
 DfsDiveFromBest
 
 DfsDiveDynamic
 
 MOST_FRACTIONAL
 
 STRONG_BRANCHING
 
 RELIABILITY_BRANCHING
 
 QP_STRONG_BRANCHING
 
 LP_STRONG_BRANCHING
 
 NLP_STRONG_BRANCHING
 
 OSI_SIMPLE
 
 OSI_STRONG
 
 RANDOM
 
 BabLogLevel
 
 BabLogInterval
 
 MaxFailures
 
 FailureBehavior
 
 MaxInfeasible
 
 NumberStrong
 
 MinReliability
 
 MaxNodes
 
 MaxSolutions
 
 MaxIterations
 
 SpecialOption
 
 DisableSos
 
 NumCutPasses
 
 NumCutPassesAtRoot
 
 RootLogLevel
 
 NumberIntParam
 
 CutoffDecr
 
 Cutoff
 
 AllowableGap
 
 AllowableFractionGap
 
 IntTol
 
 MaxTime
 
 NumberDoubleParam
 
- Protected Member Functions inherited from Bonmin::BonminSetup
void addMilpCutGenerators ()
 
void initializeBBB ()
 
void initializeBHyb (bool createContinuousSolver=false)
 
- Protected Member Functions inherited from Bonmin::BabSetupBase
void setPriorities ()
 
void addSos ()
 
- Static Protected Member Functions inherited from Bonmin::BonminSetup
static void registerMilpCutGenerators (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions)
 
- Protected Attributes inherited from Bonmin::BabSetupBase
int intParam_ [NumberIntParam]
 
double doubleParam_ [NumberDoubleParam]
 
OsiTMINLPInterfacenonlinearSolver_
 
OsiSolverInterfacecontinuousSolver_
 
Ipopt::SmartPtr< TMINLP2OsiLPlinearizer_
 
CuttingMethods cutGenerators_
 
HeuristicMethods heuristics_
 
OsiChooseVariablebranchingMethod_
 
NodeComparison nodeComparisonMethod_
 
TreeTraversal treeTraversalMethod_
 
vector< OsiObject * > objects_
 
Ipopt::SmartPtr< Ipopt::Journalistjournalist_
 
Ipopt::SmartPtr< Ipopt::OptionsListoptions_
 
Ipopt::SmartPtr< Bonmin::RegisteredOptionsroptions_
 
bool readOptions_
 
CoinMessageHandlermessageHandler_
 
std::string prefix_
 
- Static Protected Attributes inherited from Bonmin::BabSetupBase
static int defaultIntParam_ [NumberIntParam]
 
static double defaultDoubleParam_ [NumberDoubleParam]
 

Detailed Description

Definition at line 43 of file BonCouenneSetup.hpp.

Constructor & Destructor Documentation

◆ CouenneSetup() [1/2]

Couenne::CouenneSetup::CouenneSetup ( )
inline

Default constructor.

Definition at line 46 of file BonCouenneSetup.hpp.

◆ CouenneSetup() [2/2]

Couenne::CouenneSetup::CouenneSetup ( const CouenneSetup other)
inline

Copy constructor.

Definition at line 55 of file BonCouenneSetup.hpp.

◆ ~CouenneSetup()

virtual Couenne::CouenneSetup::~CouenneSetup ( )
virtual

destructor

Member Function Documentation

◆ clone()

virtual Bonmin::BabSetupBase * Couenne::CouenneSetup::clone ( ) const
inlinevirtual

virtual copy constructor.

Reimplemented from Bonmin::BonminSetup.

Definition at line 62 of file BonCouenneSetup.hpp.

◆ InitializeCouenne()

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

Initialize from command line arguments.

◆ registerOptions()

virtual void Couenne::CouenneSetup::registerOptions ( )
virtual

register the options

Reimplemented from Bonmin::BonminSetup.

◆ registerAllOptions()

static void Couenne::CouenneSetup::registerAllOptions ( Ipopt::SmartPtr< Bonmin::RegisteredOptions roptions)
static

Register all Couenne options.

◆ readOptionsFile()

virtual void Couenne::CouenneSetup::readOptionsFile ( )
inlinevirtual

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

Reimplemented from Bonmin::BabSetupBase.

Definition at line 81 of file BonCouenneSetup.hpp.

◆ couennePtr()

CouenneCutGenerator * Couenne::CouenneSetup::couennePtr ( ) const
inline

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

Definition at line 87 of file BonCouenneSetup.hpp.

◆ displayStats()

bool Couenne::CouenneSetup::displayStats ( )
inline

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

Definition at line 91 of file BonCouenneSetup.hpp.

◆ addMilpCutGenerators()

void Couenne::CouenneSetup::addMilpCutGenerators ( )

add cut generators

◆ setDoubleParameter()

void Couenne::CouenneSetup::setDoubleParameter ( const DoubleParameter p,
const double  val 
)
inline

modify parameter (used for MaxTime)

Definition at line 98 of file BonCouenneSetup.hpp.

◆ getDoubleParameter()

double Couenne::CouenneSetup::getDoubleParameter ( const DoubleParameter p) const
inline

modify parameter (used for MaxTime)

Definition at line 102 of file BonCouenneSetup.hpp.

◆ setNodeComparisonMethod()

void Couenne::CouenneSetup::setNodeComparisonMethod ( Bonmin::BabSetupBase::NodeComparison  c)
inline

Definition at line 105 of file BonCouenneSetup.hpp.


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