Generated on Sat Feb 7 2015 02:01:50 for Gecode by doxygen 1.8.9.1
Gecode::Search::Parallel::Engine Class Reference

Parallel depth-first search engine More...

#include <engine.hh>

Classes

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

Public Member Functions

const Optionsopt (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 reset (Space *s)=0
 Reset engine to restart at space s. More...
 
virtual NoGoodsnogoods (void)=0
 Return no-goods. More...
 
virtual ~Engine (void)
 Destructor. More...
 

Protected Attributes

const 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...
 
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 *, Heapsolutions
 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 Spacenext (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...
 

Detailed Description

Parallel depth-first search engine

Definition at line 49 of file engine.hh.

Member Enumeration Documentation

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
inlineprotected

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: