NetBuilder::Task::RandomSearch< NC, ET, OBSERVER > Class Template Reference

Class for CBC Search tasks. More...

#include <RandomSearch.h>

Inherits NetBuilder::Task::Search< NC, ET, OBSERVER >.

Public Member Functions
	RandomSearch (Dimension dimension, typename NetConstructionTraits< NC >::SizeParameter sizeParameter, std::unique_ptr< FigureOfMerit::FigureOfMerit > figure, unsigned nbTries, int verbose=0, bool earlyAbortion=false)
	Constructor. More...
	RandomSearch (RandomSearch &&)=default
	Default move constructor. More...
virtual std::string	format () const override
	Returns information about the task.
virtual void	reset () override
	Resets the search.
virtual void	execute () override
	Executes the search task. More...
virtual const FigureOfMerit::FigureOfMerit &	figureOfMerit () const override
	Returns a const qualified reference to the figure of merit.
Public Member Functions inherited from NetBuilder::Task::Search< NC, ET, OBSERVER >
virtual	~Search ()=default
	Virtual default destructor.
	Search (Dimension dimension, typename NetConstructionTraits< NC >::SizeParameter sizeParameter, int verbose=0, bool earlyAbortion=false)
	Constructor. More...
	Search (Dimension dimension, std::unique_ptr< DigitalNetConstruction< NC >> baseNet, int verbose=0, bool earlyAbortion=false)
	Constructor. More...
	Search (Search &&)=default
	Default move constructor. More...
Dimension	dimension () const
	Returns the dimension of the searched net.
unsigned int	nRows () const
	Returns the number of rows of the searched generating matrices.
unsigned int	nCols () const
	Returns the number of columns of the searched generating matrices.
const DigitalNetConstruction< NC > &	bestNet () const
	Returns the best net found by the search.
Real	bestMeritValue () const
	Returns the best merit found by the search. More...
bool	hasFoundNet () const
virtual std::string	outputNet (OutputFormat outputFormat, unsigned int interlacingFactor) const override
	Returns the best net found by the search task.
virtual Real	outputMeritValue () const override
	Returns the best merit value found by the search task.
Observer &	observer ()
	Returns a reference to the minimum-element observer.
const Observer &	observer () const
	Returns a const qualified reference the minimum-element observer.
OnNetSelected &	onNetSelected ()
	Net-selected signal. More...
const OnNetSelected &	onNetSelected () const
	Net-selected signal. More...
OnFailedSearch &	onFailedSearch ()
	Failed search signal. More...
const OnFailedSearch &	onFailedSearch () const
	Failed search signal. More...
const NetConstructionTraits< NC >::SizeParameter &	sizeParameter () const
	Returns a const qualified reference to the size parameter of the search.

Additional Inherited Members
Public Types inherited from NetBuilder::Task::Search< NC, ET, OBSERVER >
typedef OBSERVER< NC >	Observer
	Observer of the search.
typedef boost::signals2::signal< void(const Search< NC, ET, OBSERVER > &)>	OnNetSelected
	Signal emitted when a net has been selected.
typedef boost::signals2::signal< void(const Search< NC, ET, OBSERVER > &)>	OnFailedSearch
	Signal emitted when the search has failed.
Protected Member Functions inherited from NetBuilder::Task::Search< NC, ET, OBSERVER >
void	selectBestNet (const DigitalNetConstruction< NC > &net, Real merit)
	Selects a new best net and emits an OnNetSelected signal.
Protected Attributes inherited from NetBuilder::Task::Search< NC, ET, OBSERVER >
std::unique_ptr< OnNetSelected >	m_onNetSelected
std::unique_ptr< OnFailedSearch >	m_onFailedSearch
Dimension	m_dimension
NetConstructionTraits< NC >::SizeParameter	m_sizeParameter
unsigned int	m_nRows
unsigned int	m_nCols
DigitalNetConstruction< NC >	m_bestNet
Real	m_bestMerit
std::unique_ptr< Observer >	m_observer
int	m_verbose
bool	m_earlyAbortion

Detailed Description

template<NetConstruction NC, EmbeddingType ET, template< NetConstruction > class OBSERVER = MinimumObserver>
class NetBuilder::Task::RandomSearch< NC, ET, OBSERVER >

Class for CBC Search tasks.

Examples:

tutorial/NetQuantiles.cc.

Constructor & Destructor Documentation

RandomSearch() [1/2]

template<NetConstruction NC, EmbeddingType ET, template< NetConstruction > class OBSERVER = MinimumObserver>

NetBuilder::Task::RandomSearch< NC, ET, OBSERVER >::RandomSearch ( Dimension  dimension, typename NetConstructionTraits< NC >::SizeParameter  sizeParameter, std::unique_ptr< FigureOfMerit::FigureOfMerit >  figure, unsigned  nbTries, int  verbose = 0, bool  earlyAbortion = false  )

inline

Constructor.

Parameters

dimension	Dimension of the searched net.
sizeParameter	Size parameter of the searched net.
nbTries	Number of nets to evaluated.
figure	Figure of merit used to compare nets.
verbose	Verbosity level.
earlyAbortion	Early-abortion switch. If true, the computations will be stopped if the net is worse than the best one so far.

RandomSearch() [2/2]

template<NetConstruction NC, EmbeddingType ET, template< NetConstruction > class OBSERVER = MinimumObserver>

NetBuilder::Task::RandomSearch< NC, ET, OBSERVER >::RandomSearch ( RandomSearch< NC, ET, OBSERVER > &&  )

default

Default move constructor.

Deletes the implicit copy constructor.

Member Function Documentation

execute()

template<NetConstruction NC, EmbeddingType ET, template< NetConstruction > class OBSERVER = MinimumObserver>

virtual void NetBuilder::Task::RandomSearch< NC, ET, OBSERVER >::execute ( )

inlineoverridevirtual

Executes the search task.

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

Implements NetBuilder::Task::Search< NC, ET, OBSERVER >.

References NetBuilder::Task::Search< NC, ET, OBSERVER >::dimension(), NetBuilder::Task::Search< NC, ET, OBSERVER >::observer(), NetBuilder::Task::Search< NC, ET, OBSERVER >::onFailedSearch(), and NetBuilder::Task::Search< NC, ET, OBSERVER >::selectBestNet().

---

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

• include/netbuilder/Task/RandomSearch.h