PartitioningAlgorithm class
PartitioningAlgorithm options: outsource searches to base templated on enum type.
Contents
Base classes
-
template<typename Enum>class tk::Toggle
- Toggle is the base for an Option, doing generic searches.
Public types
- using keywords = brigand::list<kw::rcb, kw::rib, kw::hsfc, kw::mj, kw::phg>
- Valid expected choices to make them also available at compile-time.
Constructors, destructors, conversion operators
- PartitioningAlgorithm() explicit
- Options constructor.
Public functions
- auto param(PartitioningAlgorithmType m) const -> const ParamType&
- Return parameter based on Enum.
- auto geometric(PartitioningAlgorithmType m) const -> bool
Function documentation
tk::
Options constructor.
Simply initialize in-line and pass associations to base, which will handle client interactions
const ParamType& tk::
Return parameter based on Enum.
| Parameters | |
|---|---|
| m in | Enum value of the option requested |
| Returns | Library-specific parameter of the option |
Here 'parameter' is the library-specific identifier of the option, i.e., as the library identifies the given option
bool tk::
| Parameters | |
|---|---|
| m in | Enum value of the option requested |
| Returns | True if partitioning algorithm is geometric, false if it is not |