Gecode::Search::Parallel::Engine Class Reference

Parallel depth-first search engine More...

#include <engine.hh>

List of all members.

Classes
class	Worker
	Parallel depth-first search worker More...
Public Member Functions
const Options &	opt (void) const
	Provide access to search options.
unsigned int	workers (void) const
	Return number of workers.
Protected Attributes
const Options	_opt
	Search options.
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.
Support::Mutex	_m_wait
	Mutex for forcing workers to wait.
Cmd	cmd (void) const
	Return current command.
void	block (void)
	Block all workers.
void	release (Cmd c)
	Release all workers.
void	wait (void)
	Ensure that worker waits.
Termination control
Support::Mutex	_m_term
	Mutex for access to termination information.
volatile unsigned int	_n_term_not_ack
	Number of workers that have not yet acknowledged termination.
Support::Event	_e_term_ack
	Event for termination acknowledgment.
Support::Mutex	_m_wait_terminate
	Mutex for waiting for termination.
volatile unsigned int	_n_not_terminated
	Number of not yet terminated workers.
Support::Event	_e_terminate
	Event for termination (all threads have terminated).
void	ack_terminate (void)
	For worker to acknowledge termination command.
void	terminated (void)
	For worker to register termination.
void	wait_terminate (void)
	For worker to wait until termination is legal.
void	terminate (void)
	For engine to peform thread termination.
Reset control
Support::Mutex	_m_reset
	Mutex for access to reset information.
volatile unsigned int	_n_reset_not_ack
	Number of workers that have not yet acknowledged reset.
Support::Event	e_reset_ack_start
	Event for reset acknowledgment started.
Support::Event	e_reset_ack_stop
	Event for reset acknowledgment stopped.
Support::Mutex	m_wait_reset
	Mutex for waiting for reset.
void	ack_reset_start (void)
	For worker to acknowledge start of reset cycle.
void	ack_reset_stop (void)
	For worker to acknowledge stop of reset cycle.
void	wait_reset (void)
	For worker to wait for all workers to reset.
Search control
Support::Mutex	m_search
	Mutex for search.
Support::Event	e_search
	Event for search (solution found, no more solutions, search stopped).
Support::DynamicQueue< Space *, Heap >	solutions
	Queue of solutions.
volatile unsigned int	n_busy
	Number of busy workers.
volatile bool	has_stopped
	Whether a worker had been stopped.
void	idle (void)
	Report that worker is idle.
void	busy (void)
	Report that worker is busy.
void	stop (void)
	Report that worker has been stopped.
bool	signal (void) const
	Whether search state changed such that signal is needed.
Engine interface
	Engine (const Options &o)
	Initialize with options o.
virtual Space *	next (void)
	Return next solution (NULL, if none exists or search has been stopped).
virtual bool	stopped (void) const
	Check whether engine has been stopped.

---

Detailed Description

Parallel depth-first search engine

Definition at line 49 of file engine.hh.

---

Member Enumeration Documentation

enum Gecode::Search::Parallel::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 91 of file engine.hh.

---

Constructor & Destructor Documentation

Gecode::Search::Parallel::Engine::Engine

(

const Options &

o

)

[inline]

Initialize with options o.

Definition at line 260 of file engine.hh.

---

Member Function Documentation

const Options & Gecode::Search::Parallel::Engine::opt

(

void

)

const [inline]

Provide access to search options.

Definition at line 205 of file engine.hh.

unsigned int Gecode::Search::Parallel::Engine::workers

(

void

)

const [inline]

Return number of workers.

Definition at line 209 of file engine.hh.

Engine::Cmd Gecode::Search::Parallel::Engine::cmd

(

void

)

const [inline]

Return current command.

Definition at line 218 of file engine.hh.

void Gecode::Search::Parallel::Engine::block

(

void

)

[inline]

Block all workers.

Definition at line 222 of file engine.hh.

void Gecode::Search::Parallel::Engine::release

(

Cmd

c

)

[inline]

Release all workers.

Definition at line 227 of file engine.hh.

void Gecode::Search::Parallel::Engine::wait

(

void

)

[inline]

Ensure that worker waits.

Definition at line 232 of file engine.hh.

void Gecode::Search::Parallel::Engine::ack_terminate

(

void

)

[inline]

For worker to acknowledge termination command.

Definition at line 335 of file engine.hh.

void Gecode::Search::Parallel::Engine::terminated

(

void

)

[inline]

For worker to register termination.

Definition at line 323 of file engine.hh.

void Gecode::Search::Parallel::Engine::wait_terminate

(

void

)

[inline]

For worker to wait until termination is legal.

Definition at line 343 of file engine.hh.

void Gecode::Search::Parallel::Engine::terminate

(

void

)

[inline]

For engine to peform thread termination.

Definition at line 349 of file engine.hh.

void Gecode::Search::Parallel::Engine::ack_reset_start

(

void

)

[inline]

For worker to acknowledge start of reset cycle.

Definition at line 369 of file engine.hh.

void Gecode::Search::Parallel::Engine::ack_reset_stop

(

void

)

[inline]

For worker to acknowledge stop of reset cycle.

Definition at line 377 of file engine.hh.

void Gecode::Search::Parallel::Engine::wait_reset

(

void

)

[inline]

For worker to wait for all workers to reset.

Definition at line 385 of file engine.hh.

bool Gecode::Search::Parallel::Engine::signal

(

void

)

const [inline, protected]

Whether search state changed such that signal is needed.

Definition at line 289 of file engine.hh.

void Gecode::Search::Parallel::Engine::idle

(

void

)

[inline]

Report that worker is idle.

Definition at line 293 of file engine.hh.

void Gecode::Search::Parallel::Engine::busy

(

void

)

[inline]

Report that worker is busy.

Definition at line 302 of file engine.hh.

void Gecode::Search::Parallel::Engine::stop

(

void

)

[inline]

Report that worker has been stopped.

Definition at line 309 of file engine.hh.

Space * Gecode::Search::Parallel::Engine::next

(

void

)

[virtual]

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

Implements Gecode::Search::Engine.

Definition at line 50 of file engine.cpp.

bool Gecode::Search::Parallel::Engine::stopped

(

void

)

const [virtual]

Check whether engine has been stopped.

Implements Gecode::Search::Engine.

Definition at line 101 of file engine.cpp.

---

Member Data Documentation

const Options Gecode::Search::Parallel::Engine::_opt [protected]

Search options.

Definition at line 81 of file engine.hh.

volatile Cmd Gecode::Search::Parallel::Engine::_cmd [protected]

The current command.

Definition at line 99 of file engine.hh.

Support::Mutex Gecode::Search::Parallel::Engine::_m_wait [protected]

Mutex for forcing workers to wait.

Definition at line 101 of file engine.hh.

Support::Mutex Gecode::Search::Parallel::Engine::_m_term [protected]

Mutex for access to termination information.

Definition at line 117 of file engine.hh.

volatile unsigned int Gecode::Search::Parallel::Engine::_n_term_not_ack [protected]

Number of workers that have not yet acknowledged termination.

Definition at line 119 of file engine.hh.

Support::Event Gecode::Search::Parallel::Engine::_e_term_ack [protected]

Event for termination acknowledgment.

Definition at line 121 of file engine.hh.

Support::Mutex Gecode::Search::Parallel::Engine::_m_wait_terminate [protected]

Mutex for waiting for termination.

Definition at line 123 of file engine.hh.

volatile unsigned int Gecode::Search::Parallel::Engine::_n_not_terminated [protected]

Number of not yet terminated workers.

Definition at line 125 of file engine.hh.

Support::Event Gecode::Search::Parallel::Engine::_e_terminate [protected]

Event for termination (all threads have terminated).

Definition at line 127 of file engine.hh.

Support::Mutex Gecode::Search::Parallel::Engine::_m_reset [protected]

Mutex for access to reset information.

Definition at line 143 of file engine.hh.

volatile unsigned int Gecode::Search::Parallel::Engine::_n_reset_not_ack [protected]

Number of workers that have not yet acknowledged reset.

Definition at line 145 of file engine.hh.

Support::Event Gecode::Search::Parallel::Engine::e_reset_ack_start [protected]

Event for reset acknowledgment started.

Definition at line 147 of file engine.hh.

Support::Event Gecode::Search::Parallel::Engine::e_reset_ack_stop [protected]

Event for reset acknowledgment stopped.

Definition at line 149 of file engine.hh.

Support::Mutex Gecode::Search::Parallel::Engine::m_wait_reset [protected]

Mutex for waiting for reset.

Definition at line 151 of file engine.hh.

Support::Mutex Gecode::Search::Parallel::Engine::m_search [protected]

Mutex for search.

Definition at line 165 of file engine.hh.

Support::Event Gecode::Search::Parallel::Engine::e_search [protected]

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

Definition at line 167 of file engine.hh.

Support::DynamicQueue<Space*,Heap> Gecode::Search::Parallel::Engine::solutions [protected]

Queue of solutions.

Definition at line 169 of file engine.hh.

volatile unsigned int Gecode::Search::Parallel::Engine::n_busy [protected]

Number of busy workers.

Definition at line 171 of file engine.hh.

volatile bool Gecode::Search::Parallel::Engine::has_stopped [protected]

Whether a worker had been stopped.

Definition at line 173 of file engine.hh.

---

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

• gecode/search/parallel/engine.hh (Revision: 14471)
• gecode/search/parallel/engine.cpp (Revision: 13823)