Bonmin::RegisteredOptions Class Reference

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

#include <BonRegisteredOptions.hpp>

Inheritance diagram for Bonmin::RegisteredOptions:

Inheritance graph
[legend]
Collaboration diagram for Bonmin::RegisteredOptions:

Collaboration graph
[legend]
List of all members.

Public Types

 validInHybrid = 0
 validInQG
 Say that option is valid in Quesada Grossmann method.
 validInOA
 Say that option is valid in outer approximation dec.
 validInBBB
 Say that option is valid in the pure branch-and-bound.
 BonminCategory = 0
 IpoptCategory
 Option category for Ipopt.
 FilterCategory
 Option category for FilterSqp.
 BqpdCategory
 Option category for Bqpd.
 CouenneCategory
 Option category for Couenne.
enum  ExtraOptInfosBits { validInHybrid = 0, validInQG, validInOA, validInBBB }
enum  ExtraCategoriesInfo {
  BonminCategory = 0, IpoptCategory, FilterCategory, BqpdCategory,
  CouenneCategory
}

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.
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.
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 descritpions.

Private Member Functions

void chooseOptions (ExtraCategoriesInfo which, std::list< Ipopt::RegisteredOption * > &options)
 Output Latex table of options.
void writeHtmlOptionsTable (std::ostream &os, std::list< Ipopt::RegisteredOption * > &options)
 Output html table of options.
ExtraCategoriesInfo categoriesInfo (const std::string &s)
 Get categoriesInfo taking care of Ipopt.

Private Attributes

std::map< std::string, int > bonOptInfos_
 Store extra Informations on Bonmin options.
std::map< std::string, ExtraCategoriesInfocategoriesInfos_
 Store extra Informations on Registering categories (is bonmin, filterSqp.

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 24 of file BonRegisteredOptions.hpp.


Member Enumeration Documentation

enum Bonmin::RegisteredOptions::ExtraOptInfosBits

Enumerator:
validInHybrid 
validInQG  Say that option is valid in Quesada Grossmann method.
validInOA  Say that option is valid in outer approximation dec.
validInBBB  Say that option is valid in the pure branch-and-bound.

Definition at line 26 of file BonRegisteredOptions.hpp.

enum Bonmin::RegisteredOptions::ExtraCategoriesInfo

Enumerator:
BonminCategory 
IpoptCategory  Option category for Ipopt.
FilterCategory  Option category for FilterSqp.
BqpdCategory  Option category for Bqpd.
CouenneCategory  Option category for Couenne.

Definition at line 32 of file BonRegisteredOptions.hpp.


Constructor & Destructor Documentation

Bonmin::RegisteredOptions::RegisteredOptions (  )  [inline]

Standard constructor.

Reimplemented from Ipopt::RegisteredOptions.

Definition at line 40 of file BonRegisteredOptions.hpp.

Bonmin::RegisteredOptions::~RegisteredOptions (  )  [inline]

Standard destructor.

Reimplemented from Ipopt::RegisteredOptions.

Definition at line 45 of file BonRegisteredOptions.hpp.


Member Function Documentation

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

Set registering category with extra information.

Definition at line 50 of file BonRegisteredOptions.hpp.

References categoriesInfos_, and Ipopt::RegisteredOptions::SetRegisteringCategory().

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

throw if option does not exists.

Definition at line 56 of file BonRegisteredOptions.hpp.

References Ipopt::RegisteredOptions::GetOption(), and Ipopt::IsValid().

Referenced by isValidForBBB(), isValidForBOA(), isValidForBQG(), isValidForHybrid(), optionValidForBBB(), optionValidForBOA(), optionValidForBQG(), optionValidForHybrid(), and setOptionExtraInfo().

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

Set extra information for option.

Definition at line 65 of file BonRegisteredOptions.hpp.

References bonOptInfos_, and optionExists().

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

Set that option is valid for hybrid.

Definition at line 71 of file BonRegisteredOptions.hpp.

References bonOptInfos_, optionExists(), and validInHybrid.

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

Set that option is valid for QuesadaGrossmann.

Definition at line 76 of file BonRegisteredOptions.hpp.

References bonOptInfos_, optionExists(), and validInQG.

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

Set that option is valid for Outer approximation.

Definition at line 81 of file BonRegisteredOptions.hpp.

References bonOptInfos_, optionExists(), and validInOA.

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

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

Definition at line 86 of file BonRegisteredOptions.hpp.

References bonOptInfos_, optionExists(), and validInBBB.

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

Say if option is valid for hybrid.

Definition at line 92 of file BonRegisteredOptions.hpp.

References bonOptInfos_, optionExists(), and validInHybrid.

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

Say if option is valid for QuesadaGrossmann.

Definition at line 100 of file BonRegisteredOptions.hpp.

References bonOptInfos_, optionExists(), and validInQG.

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

Say if option is valid for Outer approximation.

Definition at line 108 of file BonRegisteredOptions.hpp.

References bonOptInfos_, optionExists(), and validInOA.

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

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

Definition at line 116 of file BonRegisteredOptions.hpp.

References bonOptInfos_, optionExists(), and validInBBB.

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 descritpions.

void Bonmin::RegisteredOptions::chooseOptions ( ExtraCategoriesInfo  which,
std::list< Ipopt::RegisteredOption * > &  options 
) [private]

Output Latex table of options.

void Bonmin::RegisteredOptions::writeHtmlOptionsTable ( std::ostream &  os,
std::list< Ipopt::RegisteredOption * > &  options 
) [private]

Output html table of options.

ExtraCategoriesInfo Bonmin::RegisteredOptions::categoriesInfo ( const std::string &  s  )  [inline, private]

Get categoriesInfo taking care of Ipopt.

Definition at line 144 of file BonRegisteredOptions.hpp.

References categoriesInfos_, and IpoptCategory.


Member Data Documentation

std::map<std::string, int> Bonmin::RegisteredOptions::bonOptInfos_ [private]

Store extra Informations on Bonmin options.

Definition at line 139 of file BonRegisteredOptions.hpp.

Referenced by isValidForBBB(), isValidForBOA(), isValidForBQG(), isValidForHybrid(), optionValidForBBB(), optionValidForBOA(), optionValidForBQG(), optionValidForHybrid(), and setOptionExtraInfo().

std::map<std::string, ExtraCategoriesInfo> Bonmin::RegisteredOptions::categoriesInfos_ [private]

Store extra Informations on Registering categories (is bonmin, filterSqp.

..).

Definition at line 142 of file BonRegisteredOptions.hpp.

Referenced by categoriesInfo(), and SetRegisteringCategory().


The documentation for this class was generated from the following file:
Generated on Sat Jun 21 03:20:01 2008 for Bonmin by  doxygen 1.4.7