LatBuilder::MeritFilterListPolicy< LR, EmbeddingType::MULTILEVEL > Class Template Reference
Specialization of MeritFilterListPolicy for embedded lattices. More...
#include <MeritFilterList.h>
Inherits LatBuilder::BasicMeritFilterList< LR, EmbeddingType::UNILEVEL >, and LatBuilder::BasicMeritFilterList< LR, EmbeddingType::MULTILEVEL >.
Public Types | |
| typedef BasicMeritFilter< LR, EmbeddingType::MULTILEVEL, EmbeddingType::UNILEVEL > | Combiner |
 Public Types inherited from LatBuilder::BasicMeritFilterList< LR, EmbeddingType::UNILEVEL > | |
| typedef BasicMeritFilter< LR, ET > | Filter |
| typedef Filter::InputMeritValue | MeritValue |
| typedef Filter::LatDef | LatDef |
| typedef std::list< std::unique_ptr< Filter > > | FilterList |
| typedef boost::signals2::signal< void(const LatDef &)> | OnReject |
| Type of signal emitted when a merit value is rejected. | |
| Public Types inherited from LatBuilder::BasicMeritFilterList< LR, EmbeddingType::MULTILEVEL > | |
| typedef BasicMeritFilter< LR, ET > | Filter |
| typedef Filter::InputMeritValue | MeritValue |
| typedef Filter::LatDef | LatDef |
| typedef std::list< std::unique_ptr< Filter > > | FilterList |
| typedef boost::signals2::signal< void(const LatDef &)> | OnReject |
| Type of signal emitted when a merit value is rejected. | |
Public Member Functions | |
| bool | empty () const |
Returns true if and only if the list of filters is empty. More... | |
| template<EmbeddingType L> | |
| BasicMeritFilterList< LR, L >::OnReject & | onReject () const |
| const Combiner & | combiner () const |
Setup functions | |
| void | add (std::unique_ptr< Combiner > combiner) |
| Sets the combiner for multilevel merit values. More... | |
| void | add (std::unique_ptr< typename OBase::Filter > filter) |
| void | add (std::unique_ptr< typename EBase::Filter > filter) |
| Public Member Functions inherited from LatBuilder::BasicMeritFilterList< LR, EmbeddingType::UNILEVEL > | |
| BasicMeritFilterList () | |
| Constructor. | |
| bool | empty () const |
Returns true if and only if the list of filters is empty. | |
| OnReject & | onReject () const |
| Reject signal. More... | |
| const FilterList & | filters () const |
| void | add (std::unique_ptr< Filter > filter) |
| Appends a filter for scalar merit values. More... | |
| Public Member Functions inherited from LatBuilder::BasicMeritFilterList< LR, EmbeddingType::MULTILEVEL > | |
| BasicMeritFilterList () | |
| Constructor. | |
| bool | empty () const |
Returns true if and only if the list of filters is empty. | |
| OnReject & | onReject () const |
| Reject signal. More... | |
| const FilterList & | filters () const |
| void | add (std::unique_ptr< Filter > filter) |
| Appends a filter for scalar merit values. More... | |
Protected Member Functions | |
| Real | applyFilters (const RealVector &merit, const typename EBase::LatDef &lat) const |
| Protected Member Functions inherited from LatBuilder::BasicMeritFilterList< LR, EmbeddingType::UNILEVEL > | |
| MeritValue | apply (MeritValue merit, const LatDef &lat) const |
| Protected Member Functions inherited from LatBuilder::BasicMeritFilterList< LR, EmbeddingType::MULTILEVEL > | |
| MeritValue | apply (MeritValue merit, const LatDef &lat) const |
Detailed Description
template<LatticeType LR>
class LatBuilder::MeritFilterListPolicy< LR, EmbeddingType::MULTILEVEL >
Specialization of MeritFilterListPolicy for embedded lattices.
Member Function Documentation
◆ add()
template<LatticeType LR>
|
inline |
Sets the combiner for multilevel merit values.
Clears any previously configured combiner.
◆ empty()
template<LatticeType LR>
|
inline |
Returns true if and only if the list of filters is empty.
The list of filters is considered empty when both lists of scalar and multilevel filters are empty. The combiner is ignored.
The documentation for this class was generated from the following file:
- include/latbuilder/MeritFilterList.h
