LatNet Builder Manual 2.1.3-6
Software Package for Constructing Highly Uniform Point Sets
Loading...
Searching...
No Matches
LatBuilder::BasicMeritFilterList< LR, ET > Class Template Reference

Container class for merit filters. More...

Public Types

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

 BasicMeritFilterList ()
 Constructor.
bool empty () const
 Returns true if and only if the list of filters is empty.

Setup functions

void add (std::unique_ptr< Filter > filter)
 Appends a filter for scalar merit values.
OnRejectonReject () const
 Reject signal.
const FilterList & filters () const
MeritValue apply (MeritValue merit, const LatDef &lat) const

Detailed Description

template<LatticeType LR, EmbeddingType ET>
class LatBuilder::BasicMeritFilterList< LR, ET >

Container class for merit filters.

Member Function Documentation

◆ add()

template<LatticeType LR, EmbeddingType ET>
void LatBuilder::BasicMeritFilterList< LR, ET >::add ( std::unique_ptr< Filter > filter)
inline

Appends a filter for scalar merit values.

Parameters
filterFilter function/functor to add.

◆ onReject()

template<LatticeType LR, EmbeddingType ET>
OnReject & LatBuilder::BasicMeritFilterList< LR, ET >::onReject ( ) const
inline

Reject signal.

Emitted when the a value in the output sequence is rejected by a filter.


The documentation for this class was generated from the following file:
  • include/latbuilder/MeritFilterList.h