Bonmin 1.8.9
Loading...
Searching...
No Matches
Bonmin::RegisteredOptions Class Reference

Class to add a few more information to Ipopt::RegisteredOptions. More...

#include <BonRegisteredOptions.hpp>

+ Inheritance diagram for Bonmin::RegisteredOptions:
+ Collaboration diagram for Bonmin::RegisteredOptions:

Public Types

enum  ExtraOptInfosBits {
  validInHybrid =0 , validInQG , validInOA , validInBBB ,
  validInEcp , validIniFP , validInCbc
}
 
enum  ExtraCategoriesInfo {
  BonminCategory = 0 , IpoptCategory , FilterCategory , BqpdCategory ,
  CouenneCategory , UndocumentedCategory
}
 
- Public Types inherited from Ipopt::RegisteredOptions
enum  OutputMode
 
typedef std::map< std::string, SmartPtr< RegisteredOption > > RegOptionsList
 
typedef std::map< std::string, SmartPtr< RegisteredCategory > > RegCategoriesList
 
typedef std::set< SmartPtr< RegisteredCategory >, RegisteredCategory::ComparePriorityRegCategoriesByPriority
 

Public Member Functions

 RegisteredOptions ()
 Standard constructor.
 
 ~RegisteredOptions ()
 Standard destructor.
 
void SetRegisteringCategory (const std::string &registering_category, const ExtraCategoriesInfo extra)
 Set registering category with extra information.
 
void optionExists (const std::string &option)
 throw if option does not exists.
 
void setOptionExtraInfo (const std::string &option, int code)
 Set extra information for option.
 
void optionValidForHybrid (const std::string &option)
 Set that option is valid for hybrid.
 
void optionValidForBQG (const std::string &option)
 Set that option is valid for QuesadaGrossmann.
 
void optionValidForBOA (const std::string &option)
 Set that option is valid for Outer approximation.
 
void optionValidForBBB (const std::string &option)
 Set that option is valid for pure branch-and-bound.
 
void optionValidForBEcp (const std::string &option)
 Set that option is valid for B-Ecp.
 
void optionValidForBiFP (const std::string &option)
 Set that option is valid for B-iFP.
 
void optionValidForCbc (const std::string &option)
 Set that option is valid for Cbc.
 
bool isValidForHybrid (const std::string &option)
 Say if option is valid for hybrid.
 
bool isValidForBQG (const std::string &option)
 Say if option is valid for QuesadaGrossmann.
 
bool isValidForBOA (const std::string &option)
 Say if option is valid for Outer approximation.
 
bool isValidForBBB (const std::string &option)
 Say if option is valid for pure branch-and-bound.
 
bool isValidForBEcp (const std::string &option)
 Say if option is valid for B-Ecp.
 
bool isValidForBiFP (const std::string &option)
 Say if option is valid for B-iFP.
 
bool isValidForCbc (const std::string &option)
 Say if option is valid for Cbc.
 
void writeLatexOptionsTable (std::ostream &of, ExtraCategoriesInfo which)
 Output Latex table of options.
 
void writeHtmlOptionsTable (std::ostream &of, ExtraCategoriesInfo which)
 Output html table of options.
 
void writeLatexHtmlDoc (std::ostream &of, ExtraCategoriesInfo which)
 Output Latex/Html ooptions documentation.
 
void writeBonminOpt (std::ostream &os, ExtraCategoriesInfo which)
 Ouptut a bonmin.opt file with options default values and short descriptions.
 
ExtraCategoriesInfo categoriesInfo (const std::string &s)
 Get info about what a category is taking care of (e.g., Ipopt, Bonmin, FilterSQP,...) .
 
void fillAmplOptionList (ExtraCategoriesInfo which, Ipopt::AmplOptionsList *amplOptList)
 
- Public Member Functions inherited from Ipopt::RegisteredOptions
 DECLARE_STD_EXCEPTION (OPTION_ALREADY_REGISTERED)
 
virtual void SetRegisteringCategory (const std::string &registering_category, int priority=0)
 
virtual void SetRegisteringCategory (SmartPtr< RegisteredCategory > registering_category)
 
virtual SmartPtr< RegisteredCategoryRegisteringCategory ()
 
virtual void AddNumberOption (const std::string &name, const std::string &short_description, Number default_value, const std::string &long_description="", bool advanced=false)
 
virtual void AddLowerBoundedNumberOption (const std::string &name, const std::string &short_description, Number lower, bool strict, Number default_value, const std::string &long_description="", bool advanced=false)
 
virtual void AddUpperBoundedNumberOption (const std::string &name, const std::string &short_description, Number upper, bool strict, Number default_value, const std::string &long_description="", bool advanced=false)
 
virtual void AddBoundedNumberOption (const std::string &name, const std::string &short_description, Number lower, bool lower_strict, Number upper, bool upper_strict, Number default_value, const std::string &long_description="", bool advanced=false)
 
virtual void AddIntegerOption (const std::string &name, const std::string &short_description, Index default_value, const std::string &long_description="", bool advanced=false)
 
virtual void AddLowerBoundedIntegerOption (const std::string &name, const std::string &short_description, Index lower, Index default_value, const std::string &long_description="", bool advanced=false)
 
virtual void AddUpperBoundedIntegerOption (const std::string &name, const std::string &short_description, Index upper, Index default_value, const std::string &long_description="", bool advanced=false)
 
virtual void AddBoundedIntegerOption (const std::string &name, const std::string &short_description, Index lower, Index upper, Index default_value, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption (const std::string &name, const std::string &short_description, const std::string &default_value, const std::vector< std::string > &settings, const std::vector< std::string > &descriptions, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption1 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption2 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption3 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption4 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption5 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption6 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption7 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption8 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &setting8, const std::string &description8, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption9 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &setting8, const std::string &description8, const std::string &setting9, const std::string &description9, const std::string &long_description="", bool advanced=false)
 
virtual void AddStringOption10 (const std::string &name, const std::string &short_description, const std::string &default_value, const std::string &setting1, const std::string &description1, const std::string &setting2, const std::string &description2, const std::string &setting3, const std::string &description3, const std::string &setting4, const std::string &description4, const std::string &setting5, const std::string &description5, const std::string &setting6, const std::string &description6, const std::string &setting7, const std::string &description7, const std::string &setting8, const std::string &description8, const std::string &setting9, const std::string &description9, const std::string &setting10, const std::string &description10, const std::string &long_description="", bool advanced=false)
 
virtual void AddBoolOption (const std::string &name, const std::string &short_description, bool default_value, const std::string &long_description="", bool advanced=false)
 
virtual SmartPtr< const RegisteredOptionGetOption (const std::string &name)
 
const RegOptionsListRegisteredOptionsList () const
 
const RegCategoriesListRegisteredCategories () const
 
void RegisteredCategoriesByPriority (RegCategoriesByPriority &categories) const
 
virtual void OutputOptionDocumentation (const Journalist &jnlst, SmartPtr< OptionsList > options, int minpriority=0) const
 
virtual IPOPT_DEPRECATED void OutputOptionDocumentation (const Journalist &jnlst, const std::list< std::string > &categories=std::list< std::string >()) const
 
virtual IPOPT_DEPRECATED void OutputLatexOptionDocumentation (const Journalist &jnlst, const std::list< std::string > &options_to_print=std::list< std::string >()) const
 
virtual IPOPT_DEPRECATED void OutputDoxygenOptionDocumentation (const Journalist &jnlst, const std::list< std::string > &options_to_print=std::list< std::string >()) const
 
 RegisteredOptions ()
 
 RegisteredOptions ()
 
- Public Member Functions inherited from Ipopt::ReferencedObject
 ReferencedObject ()
 
virtual ~ReferencedObject ()
 
Index ReferenceCount () const
 
void AddRef (const Referencer *referencer) const
 
void ReleaseRef (const Referencer *referencer) const
 

Additional Inherited Members

- Static Public Member Functions inherited from Ipopt::RegisteredOptions
static void RegisterOptions (SmartPtr< RegisteredOptions > roptions)
 
- Public Attributes inherited from Ipopt::RegisteredOptions
 OUTPUTTEXT
 
 OUTPUTLATEX
 
 OUTPUTDOXYGEN
 

Detailed Description

Class to add a few more information to Ipopt::RegisteredOptions.

In particular, it allows to store code to indicate in which algorithm option is available. It also allows to table summing up all the options both in LaTex and html.

Definition at line 30 of file BonRegisteredOptions.hpp.

Member Enumeration Documentation

◆ ExtraOptInfosBits

Enumerator
validInHybrid 
validInQG 

Say that option is valid in Quesada Grossmann method (2).

validInOA 

Say that option is valid in outer approximation dec (4).

validInBBB 

Say that option is valid in the pure branch-and-bound (8).

validInEcp 

Say that option is valid in the Ecp (16).

validIniFP 

Say that option is valid in the iFP (32).

validInCbc 

Say that option is valid when using Cbc_Par (64).

Definition at line 32 of file BonRegisteredOptions.hpp.

◆ ExtraCategoriesInfo

Enumerator
BonminCategory 
IpoptCategory 

Option category for Ipopt.

FilterCategory 

Option category for FilterSqp.

BqpdCategory 

Option category for Bqpd.

CouenneCategory 

Option category for Couenne.

UndocumentedCategory 

For undocumented options.

Definition at line 52 of file BonRegisteredOptions.hpp.

Constructor & Destructor Documentation

◆ RegisteredOptions()

Bonmin::RegisteredOptions::RegisteredOptions ( )
inline

Standard constructor.

Definition at line 61 of file BonRegisteredOptions.hpp.

◆ ~RegisteredOptions()

Bonmin::RegisteredOptions::~RegisteredOptions ( )
inlinevirtual

Standard destructor.

Reimplemented from Ipopt::RegisteredOptions.

Definition at line 66 of file BonRegisteredOptions.hpp.

Member Function Documentation

◆ SetRegisteringCategory()

void Bonmin::RegisteredOptions::SetRegisteringCategory ( const std::string & registering_category,
const ExtraCategoriesInfo extra )
inline

Set registering category with extra information.

Definition at line 71 of file BonRegisteredOptions.hpp.

◆ optionExists()

void Bonmin::RegisteredOptions::optionExists ( const std::string & option)
inline

throw if option does not exists.

Definition at line 77 of file BonRegisteredOptions.hpp.

◆ setOptionExtraInfo()

void Bonmin::RegisteredOptions::setOptionExtraInfo ( const std::string & option,
int code )
inline

Set extra information for option.

Definition at line 86 of file BonRegisteredOptions.hpp.

◆ optionValidForHybrid()

void Bonmin::RegisteredOptions::optionValidForHybrid ( const std::string & option)
inline

Set that option is valid for hybrid.

Definition at line 92 of file BonRegisteredOptions.hpp.

◆ optionValidForBQG()

void Bonmin::RegisteredOptions::optionValidForBQG ( const std::string & option)
inline

Set that option is valid for QuesadaGrossmann.

Definition at line 97 of file BonRegisteredOptions.hpp.

◆ optionValidForBOA()

void Bonmin::RegisteredOptions::optionValidForBOA ( const std::string & option)
inline

Set that option is valid for Outer approximation.

Definition at line 102 of file BonRegisteredOptions.hpp.

◆ optionValidForBBB()

void Bonmin::RegisteredOptions::optionValidForBBB ( const std::string & option)
inline

Set that option is valid for pure branch-and-bound.

Definition at line 107 of file BonRegisteredOptions.hpp.

◆ optionValidForBEcp()

void Bonmin::RegisteredOptions::optionValidForBEcp ( const std::string & option)
inline

Set that option is valid for B-Ecp.

Definition at line 112 of file BonRegisteredOptions.hpp.

◆ optionValidForBiFP()

void Bonmin::RegisteredOptions::optionValidForBiFP ( const std::string & option)
inline

Set that option is valid for B-iFP.

Definition at line 117 of file BonRegisteredOptions.hpp.

◆ optionValidForCbc()

void Bonmin::RegisteredOptions::optionValidForCbc ( const std::string & option)
inline

Set that option is valid for Cbc.

Definition at line 122 of file BonRegisteredOptions.hpp.

◆ isValidForHybrid()

bool Bonmin::RegisteredOptions::isValidForHybrid ( const std::string & option)
inline

Say if option is valid for hybrid.

Definition at line 128 of file BonRegisteredOptions.hpp.

◆ isValidForBQG()

bool Bonmin::RegisteredOptions::isValidForBQG ( const std::string & option)
inline

Say if option is valid for QuesadaGrossmann.

Definition at line 136 of file BonRegisteredOptions.hpp.

◆ isValidForBOA()

bool Bonmin::RegisteredOptions::isValidForBOA ( const std::string & option)
inline

Say if option is valid for Outer approximation.

Definition at line 144 of file BonRegisteredOptions.hpp.

◆ isValidForBBB()

bool Bonmin::RegisteredOptions::isValidForBBB ( const std::string & option)
inline

Say if option is valid for pure branch-and-bound.

Definition at line 152 of file BonRegisteredOptions.hpp.

◆ isValidForBEcp()

bool Bonmin::RegisteredOptions::isValidForBEcp ( const std::string & option)
inline

Say if option is valid for B-Ecp.

Definition at line 161 of file BonRegisteredOptions.hpp.

◆ isValidForBiFP()

bool Bonmin::RegisteredOptions::isValidForBiFP ( const std::string & option)
inline

Say if option is valid for B-iFP.

Definition at line 170 of file BonRegisteredOptions.hpp.

◆ isValidForCbc()

bool Bonmin::RegisteredOptions::isValidForCbc ( const std::string & option)
inline

Say if option is valid for Cbc.

Definition at line 179 of file BonRegisteredOptions.hpp.

◆ writeLatexOptionsTable()

void Bonmin::RegisteredOptions::writeLatexOptionsTable ( std::ostream & of,
ExtraCategoriesInfo which )

Output Latex table of options.

◆ writeHtmlOptionsTable()

void Bonmin::RegisteredOptions::writeHtmlOptionsTable ( std::ostream & of,
ExtraCategoriesInfo which )

Output html table of options.

◆ writeLatexHtmlDoc()

void Bonmin::RegisteredOptions::writeLatexHtmlDoc ( std::ostream & of,
ExtraCategoriesInfo which )

Output Latex/Html ooptions documentation.

◆ writeBonminOpt()

void Bonmin::RegisteredOptions::writeBonminOpt ( std::ostream & os,
ExtraCategoriesInfo which )

Ouptut a bonmin.opt file with options default values and short descriptions.

◆ categoriesInfo()

ExtraCategoriesInfo Bonmin::RegisteredOptions::categoriesInfo ( const std::string & s)
inline

Get info about what a category is taking care of (e.g., Ipopt, Bonmin, FilterSQP,...) .

Definition at line 200 of file BonRegisteredOptions.hpp.

◆ fillAmplOptionList()

void Bonmin::RegisteredOptions::fillAmplOptionList ( ExtraCategoriesInfo which,
Ipopt::AmplOptionsList * amplOptList )

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