Parallel depth-first search engine More...

#include <engine.hh>

Classes
class	Worker
	Parallel depth-first search worker More...

Public Member Functions
const Options &	opt (void) const
	Provide access to search options. More...

unsigned int	workers (void) const
	Return number of workers. More...

Public Member Functions inherited from Gecode::Search::Engine
virtual Statistics	statistics (void) const =0
	Return statistics. More...

virtual void	constrain (const Space &b)
	Constrain future solutions to be better than b (raises exception) More...

virtual void	reset (Space *s)
	Reset engine to restart at space s (does nothing) More...

virtual NoGoods &	nogoods (void)
	Return no-goods (the no-goods are empty) More...

virtual	~Engine (void)
	Destructor. More...

Public Member Functions inherited from Gecode::Support::Terminator
virtual	~Terminator ()
	Destructor. More...

Protected Attributes
Options	_opt
	Search options. More...

Commands from engine to workers and wait management
enum	Cmd { C_WORK, C_WAIT, C_RESET, C_TERMINATE }
	Commands from engine to workers. More...

volatile Cmd	_cmd
	The current command. More...

Support::Mutex	_m_wait
	Mutex for forcing workers to wait. More...

Cmd	cmd (void) const
	Return current command. More...

void	block (void)
	Block all workers. More...

void	release (Cmd c)
	Release all workers. More...

void	wait (void)
	Ensure that worker waits. More...

Termination control
Support::Mutex	_m_term
	Mutex for access to termination information. More...

volatile unsigned int	_n_term_not_ack
	Number of workers that have not yet acknowledged termination. More...

Support::Event	_e_term_ack
	Event for termination acknowledgment. More...

Support::Mutex	_m_wait_terminate
	Mutex for waiting for termination. More...

volatile unsigned int	_n_not_terminated
	Number of not yet terminated workers. More...

Support::Event	_e_terminate
	Event for termination (all threads have terminated) More...

void	ack_terminate (void)
	For worker to acknowledge termination command. More...

virtual void	terminated (void)
	For worker to register termination. More...

void	wait_terminate (void)
	For worker to wait until termination is legal. More...

void	terminate (void)
	For engine to peform thread termination. More...

Reset control
Support::Mutex	_m_reset
	Mutex for access to reset information. More...

volatile unsigned int	_n_reset_not_ack
	Number of workers that have not yet acknowledged reset. More...

Support::Event	e_reset_ack_start
	Event for reset acknowledgment started. More...

Support::Event	e_reset_ack_stop
	Event for reset acknowledgment stopped. More...

Support::Mutex	m_wait_reset
	Mutex for waiting for reset. More...

void	ack_reset_start (void)
	For worker to acknowledge start of reset cycle. More...

void	ack_reset_stop (void)
	For worker to acknowledge stop of reset cycle. More...

void	wait_reset (void)
	For worker to wait for all workers to reset. More...

Search control
Support::Mutex	m_search
	Mutex for search. More...

Support::Event	e_search
	Event for search (solution found, no more solutions, search stopped) More...

Support::DynamicQueue< Space *, Heap >	solutions
	Queue of solutions. More...

volatile unsigned int	n_busy
	Number of busy workers. More...

volatile bool	has_stopped
	Whether a worker had been stopped. More...

void	idle (void)
	Report that worker is idle. More...

void	busy (void)
	Report that worker is busy. More...

void	stop (void)
	Report that worker has been stopped. More...

bool	signal (void) const
	Whether search state changed such that signal is needed. More...

Engine interface
	Engine (const Options &o)
	Initialize with options o. More...

virtual Space *	next (void)
	Return next solution (NULL, if none exists or search has been stopped) More...

virtual bool	stopped (void) const
	Check whether engine has been stopped. More...

Additional Inherited Members
Static Public Member Functions inherited from Gecode::HeapAllocated
static void *	operator new (size_t s)
	Memory management. More...

static void	operator delete (void *p)
	Free memory allocated from heap. More...

Detailed Description

template<class Tracer>
class Gecode::Search::Par::Engine< Tracer >

Parallel depth-first search engine

Definition at line 50 of file engine.hh.

Member Enumeration Documentation

◆ Cmd

template<class Tracer >

enum Gecode::Search::Par::Engine::Cmd

Commands from engine to workers.

Enumerator
C_WORK	Perform work.
C_WAIT	Run into wait lock.
C_RESET	Perform reset operation.
C_TERMINATE	Terminate.

Definition at line 97 of file engine.hh.

Constructor & Destructor Documentation

◆ Engine()

template<class Tracer >

Gecode::Search::Par::Engine< Tracer >::Engine ( const Options & o )

inline

Initialize with options o.

Definition at line 120 of file engine.hpp.

Member Function Documentation

◆ opt()

template<class Tracer >

const Options & Gecode::Search::Par::Engine< Tracer >::opt ( void ) const

inline

Provide access to search options.

Definition at line 51 of file engine.hpp.

◆ workers()

template<class Tracer >

unsigned int Gecode::Search::Par::Engine< Tracer >::workers ( void ) const

inline

Return number of workers.

Definition at line 56 of file engine.hpp.

◆ cmd()

template<class Tracer >

Engine< Tracer >::Cmd Gecode::Search::Par::Engine< Tracer >::cmd ( void ) const

inline

Return current command.

Definition at line 72 of file engine.hpp.

◆ block()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::block ( void )

inline

Block all workers.

Definition at line 77 of file engine.hpp.

◆ release()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::release ( Cmd c )

inline

Release all workers.

Definition at line 83 of file engine.hpp.

◆ wait()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::wait ( void )

inline

Ensure that worker waits.

Definition at line 89 of file engine.hpp.

◆ ack_terminate()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::ack_terminate ( void )

inline

For worker to acknowledge termination command.

Definition at line 204 of file engine.hpp.

◆ terminated()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::terminated ( void )

inlinevirtual

For worker to register termination.

Implements Gecode::Support::Terminator.

Definition at line 191 of file engine.hpp.

◆ wait_terminate()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::wait_terminate ( void )

inline

For worker to wait until termination is legal.

Definition at line 213 of file engine.hpp.

◆ terminate()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::terminate ( void )

inline

For engine to peform thread termination.

Definition at line 220 of file engine.hpp.

◆ ack_reset_start()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::ack_reset_start ( void )

inline

For worker to acknowledge start of reset cycle.

Definition at line 239 of file engine.hpp.

◆ ack_reset_stop()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::ack_reset_stop ( void )

inline

For worker to acknowledge stop of reset cycle.

Definition at line 248 of file engine.hpp.

◆ wait_reset()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::wait_reset ( void )

inline

For worker to wait for all workers to reset.

Definition at line 257 of file engine.hpp.

◆ signal()

template<class Tracer >

bool Gecode::Search::Par::Engine< Tracer >::signal ( void ) const

inlineprotected

Whether search state changed such that signal is needed.

Definition at line 151 of file engine.hpp.

◆ idle()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::idle ( void )

inline

Report that worker is idle.

Definition at line 156 of file engine.hpp.

◆ busy()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::busy ( void )

inline

Report that worker is busy.

Definition at line 167 of file engine.hpp.

◆ stop()

template<class Tracer >

void Gecode::Search::Par::Engine< Tracer >::stop ( void )

inline

Report that worker has been stopped.

Definition at line 176 of file engine.hpp.

◆ next()

template<class Tracer >

Space * Gecode::Search::Par::Engine< Tracer >::next ( void )

virtual

Return next solution (NULL, if none exists or search has been stopped)

Implements Gecode::Search::Engine.

Reimplemented in Gecode::Search::Par::PBS< Collect >, and Gecode::Search::Par::PBS< Gecode::Search::Par::CollectBest >.

Definition at line 302 of file engine.hpp.

◆ stopped()

template<class Tracer >

bool Gecode::Search::Par::Engine< Tracer >::stopped ( void ) const

inlinevirtual

Check whether engine has been stopped.

Implements Gecode::Search::Engine.

Reimplemented in Gecode::Search::Par::PBS< Collect >, and Gecode::Search::Par::PBS< Gecode::Search::Par::CollectBest >.

Definition at line 61 of file engine.hpp.

Member Data Documentation

◆ _opt

template<class Tracer >

Options Gecode::Search::Par::Engine< Tracer >::_opt

protected

Search options.

Definition at line 87 of file engine.hh.

◆ _cmd

template<class Tracer >

volatile Cmd Gecode::Search::Par::Engine< Tracer >::_cmd

protected

The current command.

Definition at line 105 of file engine.hh.

◆ _m_wait

template<class Tracer >

Support::Mutex Gecode::Search::Par::Engine< Tracer >::_m_wait

protected

Mutex for forcing workers to wait.

Definition at line 107 of file engine.hh.

◆ _m_term

template<class Tracer >

Support::Mutex Gecode::Search::Par::Engine< Tracer >::_m_term

protected

Mutex for access to termination information.

Definition at line 123 of file engine.hh.

◆ _n_term_not_ack

template<class Tracer >

volatile unsigned int Gecode::Search::Par::Engine< Tracer >::_n_term_not_ack

protected

Number of workers that have not yet acknowledged termination.

Definition at line 125 of file engine.hh.

◆ _e_term_ack

template<class Tracer >

Support::Event Gecode::Search::Par::Engine< Tracer >::_e_term_ack

protected

Event for termination acknowledgment.

Definition at line 127 of file engine.hh.

◆ _m_wait_terminate

template<class Tracer >

Support::Mutex Gecode::Search::Par::Engine< Tracer >::_m_wait_terminate

protected

Mutex for waiting for termination.

Definition at line 129 of file engine.hh.

◆ _n_not_terminated

template<class Tracer >

volatile unsigned int Gecode::Search::Par::Engine< Tracer >::_n_not_terminated

protected

Number of not yet terminated workers.

Definition at line 131 of file engine.hh.

◆ _e_terminate

template<class Tracer >

Support::Event Gecode::Search::Par::Engine< Tracer >::_e_terminate

protected

Event for termination (all threads have terminated)

Definition at line 133 of file engine.hh.

◆ _m_reset

template<class Tracer >

Support::Mutex Gecode::Search::Par::Engine< Tracer >::_m_reset

protected

Mutex for access to reset information.

Definition at line 149 of file engine.hh.

◆ _n_reset_not_ack

template<class Tracer >

volatile unsigned int Gecode::Search::Par::Engine< Tracer >::_n_reset_not_ack

protected

Number of workers that have not yet acknowledged reset.

Definition at line 151 of file engine.hh.

◆ e_reset_ack_start

template<class Tracer >

Support::Event Gecode::Search::Par::Engine< Tracer >::e_reset_ack_start

protected

Event for reset acknowledgment started.

Definition at line 153 of file engine.hh.

◆ e_reset_ack_stop

template<class Tracer >

Support::Event Gecode::Search::Par::Engine< Tracer >::e_reset_ack_stop

protected

Event for reset acknowledgment stopped.

Definition at line 155 of file engine.hh.

◆ m_wait_reset

template<class Tracer >

Support::Mutex Gecode::Search::Par::Engine< Tracer >::m_wait_reset

protected

Mutex for waiting for reset.

Definition at line 157 of file engine.hh.

◆ m_search

template<class Tracer >

Support::Mutex Gecode::Search::Par::Engine< Tracer >::m_search

protected

Mutex for search.

Definition at line 171 of file engine.hh.

◆ e_search

template<class Tracer >

Support::Event Gecode::Search::Par::Engine< Tracer >::e_search

protected

Event for search (solution found, no more solutions, search stopped)

Definition at line 173 of file engine.hh.

◆ solutions

template<class Tracer >

Support::DynamicQueue<Space*,Heap> Gecode::Search::Par::Engine< Tracer >::solutions

protected

Queue of solutions.

Definition at line 175 of file engine.hh.

◆ n_busy

template<class Tracer >

volatile unsigned int Gecode::Search::Par::Engine< Tracer >::n_busy

protected

Number of busy workers.

Definition at line 177 of file engine.hh.

◆ has_stopped

template<class Tracer >

volatile bool Gecode::Search::Par::Engine< Tracer >::has_stopped

protected

Whether a worker had been stopped.

Definition at line 179 of file engine.hh.

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

gecode/search/par/engine.hh
gecode/search/par/engine.hpp

Classes

Public Member Functions

Protected Attributes

Commands from engine to workers and wait management

Termination control

Reset control

Search control

Engine interface

Additional Inherited Members

Detailed Description

template<class Tracer> class Gecode::Search::Par::Engine< Tracer >

Member Enumeration Documentation

◆ Cmd

Constructor & Destructor Documentation

◆ Engine()

Member Function Documentation

◆ opt()

◆ workers()

◆ cmd()

◆ block()

◆ release()

◆ wait()

◆ ack_terminate()

◆ terminated()

◆ wait_terminate()

◆ terminate()

◆ ack_reset_start()

◆ ack_reset_stop()

◆ wait_reset()

◆ signal()

◆ idle()

◆ busy()

◆ stop()

◆ next()

◆ stopped()

Member Data Documentation

◆ _opt

◆ _cmd

◆ _m_wait

◆ _m_term

◆ _n_term_not_ack

◆ _e_term_ack

◆ _m_wait_terminate

◆ _n_not_terminated

◆ _e_terminate

◆ _m_reset

◆ _n_reset_not_ack

◆ e_reset_ack_start

◆ e_reset_ack_stop

◆ m_wait_reset

◆ m_search

◆ e_search

◆ solutions

◆ n_busy

◆ has_stopped

template<class Tracer>
class Gecode::Search::Par::Engine< Tracer >