main page namespaces classes files
ELL home

ell::Walk Class Reference

#include <Walk.hh>

Inheritance diagram for ell::Walk:

[legend]

---

Detailed Description

Walk is an abstract class which defines:

• a static function "walk" which takes all neccesary params for a generic walk This static function Walk::walk is then invoked by
• a virtual member function "walk" which only takes a state to start and a walk collector This virtual function then usually(not mandatory) invokes the static function Walk::walk with fixed params depending on the type of walk(=the class type), e.g. RandomWalk has member "length" and therefore creates a special WalkAbortionCriterion.. In addition every child of the Walk class has a static member which essentially does the same as the virtual member function(usually invoking Walk::walk) but with the use of additional params instead of members

Author:

: Hannes Kochniß, Daniel Maticzka, Martin Mann

Definition at line 29 of file Walk.hh.

Public Member Functions
virtual StateCollector *	walk (const State *const start, StateCollector *const scWalk, StateCollector *scRejected=NULL) const=0
virtual	~Walk ()
Static Public Member Functions
static StateCollector *	walk (const State *const start, StateCollector *const scWalk, const NeighborGenerator *const ng, const StateAcceptor *const sa, const WalkAbortionCriterion *const wac, StateCollector *scRejected=NULL)

---

Constructor & Destructor Documentation

virtual ell::Walk::~Walk

(

)

[inline, virtual]

virtual destructor

Definition at line 33 of file Walk.hh.

---

Member Function Documentation

StateCollector * ell::Walk::walk	(	const State *const	start,
		StateCollector *const	scWalk,
		const NeighborGenerator *const	ng,
		const StateAcceptor *const	sa,
		const WalkAbortionCriterion *const	wac,
		StateCollector *	scRejected = NULL
	)			[static]

This function implements a generic walk starting from State start. The properties of this search are defined by the implementations of NeighborhoodGenerator, StateAcceptor WalkAbortionCriterion and StateCollector.

Parameters:

	start	the begin of the walk
	scWalk	the StateCollector each step of the walk is added to
	ng	the NeighborGenerator used to get the neighbor list of the last walk State to generate the next possible steps
	sa	the StateAcceptor that decides if a step is accepted or rejected
	wac	the walk abortion criterion that decides if the end of the walk has been reached or a further step is to do
	scRejected	the StateCollector each rejected possible step is added to

Returns:

the modified scWalk StateCollector

Definition at line 13 of file Walk.cc.

virtual StateCollector* ell::Walk::walk	(	const State *const	start,
		StateCollector *const	scWalk,
		StateCollector *	scRejected = NULL
	)			const [pure virtual]

pure virtual function, s is start state

Parameters:

	start	the begin of the walk
	scWalk	the StateCollector each step of the walk is added to
	scRejected	the StateCollector each rejected possible step is added to

Returns:

the modified scWalk StateCollector

Implemented in ell::WalkAdaptive, ell::WalkGradient, ell::WalkMC, and ell::WalkRandom.

---

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

• src/ell/Walk.hh
• src/ell/Walk.cc