Bonmin 1.8.9
|
Class to add a few more information to Ipopt::RegisteredOptions. More...
#include <BonRegisteredOptions.hpp>
Public Types | |
enum | ExtraOptInfosBits { validInHybrid =0 , validInQG , validInOA , validInBBB , validInEcp , validIniFP , validInCbc } |
enum | ExtraCategoriesInfo { BonminCategory = 0 , IpoptCategory , FilterCategory , BqpdCategory , CouenneCategory , UndocumentedCategory } |
![]() | |
enum | OutputMode |
typedef std::map< std::string, SmartPtr< RegisteredOption > > | RegOptionsList |
typedef std::map< std::string, SmartPtr< RegisteredCategory > > | RegCategoriesList |
typedef std::set< SmartPtr< RegisteredCategory >, RegisteredCategory::ComparePriority > | RegCategoriesByPriority |
Public Member Functions | |
RegisteredOptions () | |
Standard constructor. | |
~RegisteredOptions () | |
Standard destructor. | |
void | SetRegisteringCategory (const std::string ®istering_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) |
![]() | |
DECLARE_STD_EXCEPTION (OPTION_ALREADY_REGISTERED) | |
virtual void | SetRegisteringCategory (const std::string ®istering_category, int priority=0) |
virtual void | SetRegisteringCategory (SmartPtr< RegisteredCategory > registering_category) |
virtual SmartPtr< RegisteredCategory > | RegisteringCategory () |
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 RegisteredOption > | GetOption (const std::string &name) |
const RegOptionsList & | RegisteredOptionsList () const |
const RegCategoriesList & | RegisteredCategories () 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 () | |
![]() | |
ReferencedObject () | |
virtual | ~ReferencedObject () |
Index | ReferenceCount () const |
void | AddRef (const Referencer *referencer) const |
void | ReleaseRef (const Referencer *referencer) const |
Additional Inherited Members | |
![]() | |
static void | RegisterOptions (SmartPtr< RegisteredOptions > roptions) |
![]() | |
OUTPUTTEXT | |
OUTPUTLATEX | |
OUTPUTDOXYGEN | |
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.
Definition at line 32 of file BonRegisteredOptions.hpp.
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.
|
inline |
Standard constructor.
Definition at line 61 of file BonRegisteredOptions.hpp.
|
inlinevirtual |
Standard destructor.
Reimplemented from Ipopt::RegisteredOptions.
Definition at line 66 of file BonRegisteredOptions.hpp.
|
inline |
Set registering category with extra information.
Definition at line 71 of file BonRegisteredOptions.hpp.
|
inline |
throw if option does not exists.
Definition at line 77 of file BonRegisteredOptions.hpp.
|
inline |
Set extra information for option.
Definition at line 86 of file BonRegisteredOptions.hpp.
|
inline |
Set that option is valid for hybrid.
Definition at line 92 of file BonRegisteredOptions.hpp.
|
inline |
Set that option is valid for QuesadaGrossmann.
Definition at line 97 of file BonRegisteredOptions.hpp.
|
inline |
Set that option is valid for Outer approximation.
Definition at line 102 of file BonRegisteredOptions.hpp.
|
inline |
Set that option is valid for pure branch-and-bound.
Definition at line 107 of file BonRegisteredOptions.hpp.
|
inline |
Set that option is valid for B-Ecp.
Definition at line 112 of file BonRegisteredOptions.hpp.
|
inline |
Set that option is valid for B-iFP.
Definition at line 117 of file BonRegisteredOptions.hpp.
|
inline |
Set that option is valid for Cbc.
Definition at line 122 of file BonRegisteredOptions.hpp.
|
inline |
Say if option is valid for hybrid.
Definition at line 128 of file BonRegisteredOptions.hpp.
|
inline |
Say if option is valid for QuesadaGrossmann.
Definition at line 136 of file BonRegisteredOptions.hpp.
|
inline |
Say if option is valid for Outer approximation.
Definition at line 144 of file BonRegisteredOptions.hpp.
|
inline |
Say if option is valid for pure branch-and-bound.
Definition at line 152 of file BonRegisteredOptions.hpp.
|
inline |
Say if option is valid for B-Ecp.
Definition at line 161 of file BonRegisteredOptions.hpp.
|
inline |
Say if option is valid for B-iFP.
Definition at line 170 of file BonRegisteredOptions.hpp.
|
inline |
Say if option is valid for Cbc.
Definition at line 179 of file BonRegisteredOptions.hpp.
void Bonmin::RegisteredOptions::writeLatexOptionsTable | ( | std::ostream & | of, |
ExtraCategoriesInfo | which ) |
Output Latex table of options.
void Bonmin::RegisteredOptions::writeHtmlOptionsTable | ( | std::ostream & | of, |
ExtraCategoriesInfo | which ) |
Output html table of options.
void Bonmin::RegisteredOptions::writeLatexHtmlDoc | ( | std::ostream & | of, |
ExtraCategoriesInfo | which ) |
Output Latex/Html ooptions documentation.
void Bonmin::RegisteredOptions::writeBonminOpt | ( | std::ostream & | os, |
ExtraCategoriesInfo | which ) |
Ouptut a bonmin.opt file with options default values and short descriptions.
|
inline |
Get info about what a category is taking care of (e.g., Ipopt, Bonmin, FilterSQP,...) .
Definition at line 200 of file BonRegisteredOptions.hpp.
void Bonmin::RegisteredOptions::fillAmplOptionList | ( | ExtraCategoriesInfo | which, |
Ipopt::AmplOptionsList * | amplOptList ) |