Generated on Sat Nov 11 01:12:22 2006 for Gecode by doxygen 1.5.1

Gecode::Search::EngineCtrl Class Reference

#include <search.hh>

Inherits Gecode::Search::Statistics.

Inherited by Gecode::Search::BabEngine, Gecode::Search::DfsEngine, and Gecode::Search::ProbeEngine.

List of all members.


Detailed Description

Search engine control including memory information

Definition at line 192 of file search.hh.

Public Member Functions

 EngineCtrl (Stop *st, size_t sz)
 Initialize with stop-object st and space size sz.
void start (void)
 Reset stop information.
bool stop (size_t sz)
 Check whether engine must be stopped (with additional stackspace sz).
bool stopped (void) const
 Check whether engine has been stopped.
void push (const Space *s, const BranchingDesc *d)
 New space s and branching description d get pushed on stack.
void constrained (const Space *s1, const Space *s2)
 Space s1 is replaced by space s2 due to constraining.
void adapt (const Space *s)
 New space s is added for adaptive recomputation.
void pop (const Space *s, const BranchingDesc *d)
 Space s and branching description d get popped from stack.
void lao (const Space *s)
 Space s gets used for LAO (removed from stack).
void current (const Space *s)
 Space s becomes current space (s = NULL: current space deleted).
void reset (const Space *s)
 Reset statistics for space s.

Protected Attributes

Stopst
 Stop-object to be used
bool _stopped
 Whether engine has been stopped.
size_t mem_space
 Memory required for a single space.
size_t mem_cur
 Memory for the current space (including memory for caching).
size_t mem_total
 Current total memory.


Constructor & Destructor Documentation

Gecode::Search::EngineCtrl::EngineCtrl ( Stop st,
size_t  sz 
) [inline]

Initialize with stop-object st and space size sz.

Definition at line 25 of file engine-ctrl.icc.


Member Function Documentation

void Gecode::Search::EngineCtrl::start ( void   )  [inline]

Reset stop information.

Definition at line 31 of file engine-ctrl.icc.

bool Gecode::Search::EngineCtrl::stop ( size_t  sz  )  [inline]

Check whether engine must be stopped (with additional stackspace sz).

Definition at line 36 of file engine-ctrl.icc.

bool Gecode::Search::EngineCtrl::stopped ( void   )  const [inline]

Check whether engine has been stopped.

Definition at line 46 of file engine-ctrl.icc.

void Gecode::Search::EngineCtrl::push ( const Space s,
const BranchingDesc d 
) [inline]

New space s and branching description d get pushed on stack.

Definition at line 51 of file engine-ctrl.icc.

void Gecode::Search::EngineCtrl::constrained ( const Space s1,
const Space s2 
) [inline]

Space s1 is replaced by space s2 due to constraining.

Definition at line 67 of file engine-ctrl.icc.

void Gecode::Search::EngineCtrl::adapt ( const Space s  )  [inline]

New space s is added for adaptive recomputation.

Definition at line 60 of file engine-ctrl.icc.

void Gecode::Search::EngineCtrl::pop ( const Space s,
const BranchingDesc d 
) [inline]

Space s and branching description d get popped from stack.

Definition at line 80 of file engine-ctrl.icc.

void Gecode::Search::EngineCtrl::lao ( const Space s  )  [inline]

Space s gets used for LAO (removed from stack).

Definition at line 75 of file engine-ctrl.icc.

void Gecode::Search::EngineCtrl::current ( const Space s  )  [inline]

Space s becomes current space (s = NULL: current space deleted).

Definition at line 87 of file engine-ctrl.icc.

void Gecode::Search::EngineCtrl::reset ( const Space s  )  [inline]

Reset statistics for space s.

Definition at line 100 of file engine-ctrl.icc.


Member Data Documentation

Stop-object to be used

Definition at line 195 of file search.hh.

Whether engine has been stopped.

Definition at line 197 of file search.hh.

Memory required for a single space.

Definition at line 199 of file search.hh.

Memory for the current space (including memory for caching).

Definition at line 201 of file search.hh.

Current total memory.

Definition at line 203 of file search.hh.


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