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 241 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.
void	reset (void)
	Reset statistics for failed space.
Protected Attributes
Stop *	st
	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 41 of file engine-ctrl.icc.

---

Member Function Documentation

void Gecode::Search::EngineCtrl::start

(

void

)

[inline]

Reset stop information.

Definition at line 47 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 52 of file engine-ctrl.icc.

bool Gecode::Search::EngineCtrl::stopped

(

void

)

const [inline]

Check whether engine has been stopped.

Definition at line 62 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 67 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 83 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 76 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 96 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 91 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 103 of file engine-ctrl.icc.

void Gecode::Search::EngineCtrl::reset

(

const Space *

s

)

[inline]

Reset statistics for space s.

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

void Gecode::Search::EngineCtrl::reset

(

void

)

[inline]

Reset statistics for failed space.

Reimplemented in Gecode::Search::DfsEngine.

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

---

Member Data Documentation

Stop* Gecode::Search::EngineCtrl::st [protected]

Stop-object to be used

Definition at line 244 of file search.hh.

bool Gecode::Search::EngineCtrl::_stopped [protected]

Whether engine has been stopped.

Definition at line 246 of file search.hh.

size_t Gecode::Search::EngineCtrl::mem_space [protected]

Memory required for a single space.

Definition at line 248 of file search.hh.

size_t Gecode::Search::EngineCtrl::mem_cur [protected]

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

Definition at line 250 of file search.hh.

size_t Gecode::Search::EngineCtrl::mem_total [protected]

Current total memory.

Definition at line 252 of file search.hh.

---

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

• gecode/search.hh (Revision: 7310)
• gecode/search/engine-ctrl.icc (Revision: 6062)