LatBuilder::Task::Search< LR, ET > Class Template Reference

Base class for search tasks. More...

#include <Search.h>

Inherits LatBuilder::Task::Task.

Inherited by LatBuilder::Task::Extend< LR, ET, COMPRESS, PLO, FIGURE >.

Classes
class	MinObserver
	Observer of the MinElement functor. More...

Public Types
typedef boost::signals2::signal< void(const Search &)>	OnLatticeSelected

Public Member Functions
	Search (Dimension dimension)
	Search (Search &&other)
Dimension	dimension () const
	Returns the dimension.
int	verbose () const
void	setVerbose (int verbose)
const MeritFilterList< LR, ET > &	filters () const
	Returns the filters of merit transformations.
MeritFilterList< LR, ET > &	filters ()
	Returns the filters of merit transformations.
const LatDef< LR, ET > &	bestLattice () const
	Returns the best lattice found by the search task.
Real	bestMeritValue () const
	Returns the best merit value found by the search task.
const Functor::MinElement< Real > &	minElement () const
MinObserver &	minObserver ()
	Returns the minimum-element observer.
const MinObserver &	minObserver () const
void	setObserverVerbosity (int verbose) const
void	setObserverTotalDim (Dimension totalDim) const
OnLatticeSelected &	onLatticeSelected ()
	Lattice-selected signal.
const OnLatticeSelected &	onLatticeSelected () const
virtual const FigureOfMerit &	figureOfMerit () const =0
virtual void	execute ()=0
	Executes the search task.
virtual void	reset ()
	Initializes the best lattice and merit value.

Protected Member Functions
virtual void	format (std::ostream &os) const
void	selectBestLattice (const LatDef< LR, ET > &lattice, Real merit, bool quiet)
	Selects a new best lattice and emits an OnLatticeSelected signal, if quiet is set to false.

Detailed Description

template<LatticeType LR, EmbeddingType ET>
class LatBuilder::Task::Search< LR, ET >

Base class for search tasks.

Template Parameters

ET	Type of lattice.

Member Function Documentation

execute()

template<LatticeType LR, EmbeddingType ET>

virtual void LatBuilder::Task::Search< LR, ET >::execute ( )

pure virtual

Executes the search task.

The best lattice and merit value are set in the process.

Implements LatBuilder::Task::Task.

Implemented in LatBuilder::Task::Extend< LR, ET, COMPRESS, PLO, FIGURE >.

figureOfMerit()

template<LatticeType LR, EmbeddingType ET>

virtual const FigureOfMerit & LatBuilder::Task::Search< LR, ET >::figureOfMerit ( ) const

pure virtual

Implemented in LatBuilder::Task::Extend< LR, ET, COMPRESS, PLO, FIGURE >.

filters()

template<LatticeType LR, EmbeddingType ET>

MeritFilterList< LR, ET > & LatBuilder::Task::Search< LR, ET >::filters ( )

inline

Returns the filters of merit transformations.

format()

template<LatticeType LR, EmbeddingType ET>

virtual void LatBuilder::Task::Search< LR, ET >::format ( std::ostream & os ) const

inlineprotectedvirtual

Implements LatBuilder::Task::Task.

onLatticeSelected()

template<LatticeType LR, EmbeddingType ET>

OnLatticeSelected & LatBuilder::Task::Search< LR, ET >::onLatticeSelected ( )

inline

Lattice-selected signal.

Emitted when a lattice has been selected by the search algorithm.

Referenced by selectBestLattice().

---

The documentation for this class was generated from the following file:

• include/latbuilder/Task/Search.h