ell::WalkRandom Class Reference
#include <Walk.hh>
Inheritance diagram for ell::WalkRandom:
Detailed Description
WalkRandom is a class for a random walk, it defines:- a static function "walkRandom" which takes all neccesary params for a random walk
- a virtual member function "walk" which does the same as "walkRandom" but substitutes the parameter wac of "walkRandom" with a member (see constructor)
Definition at line 263 of file Walk.hh.
Public Member Functions | |
| virtual StateCollector * | walk (const State *const start, StateCollector *const scWalk, StateCollector *const scRejected=NULL) const |
| WalkRandom (const WalkAbortionCriterion *const wac) | |
| virtual | ~WalkRandom () |
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) |
| static StateCollector * | walkRandom (const State *const start, StateCollector *const scWalk, const WalkAbortionCriterion *const wac, StateCollector *const scRejected=NULL) |
Protected Attributes | |
| const WalkAbortionCriterion *const | wac |
Constructor & Destructor Documentation
| ell::WalkRandom::WalkRandom | ( | const WalkAbortionCriterion *const | wac | ) |
constructor which takes the length of the random walk
- Parameters:
-
wac the WalkAbortionCriterion that will decide if one more step is done or not
| virtual ell::WalkRandom::~WalkRandom | ( | ) | [inline, virtual] |
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, inherited] |
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
| StateCollector * ell::WalkRandom::walk | ( | const State *const | start, | |
| StateCollector *const | scWalk, | |||
| StateCollector *const | scRejected = NULL | |||
| ) | const [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
Implements ell::Walk.
| StateCollector * ell::WalkRandom::walkRandom | ( | const State *const | start, | |
| StateCollector *const | scWalk, | |||
| const WalkAbortionCriterion *const | wac, | |||
| StateCollector *const | scRejected = NULL | |||
| ) | [static] |
- Parameters:
-
start the begin of the walk scWalk the StateCollector each step of the walk is added to wac the WalkAbortionCriterion that will decide if one more step is done or not scRejected the StateCollector each rejected possible step is added to
- Returns:
- the modified scWalk StateCollector
Field Documentation
const WalkAbortionCriterion* const ell::WalkRandom::wac [protected] |
the WalkAbortionCriterion that decides if one more step is done or not
The documentation for this class was generated from the following files: