main page namespaces classes files
ELL home

ell::WalkMC Class Reference

#include <Walk.hh>

Inheritance diagram for ell::WalkMC:

[legend]

---

Detailed Description

WalkMC is a class for a Monte Carlo Walk, it defines:

• a static function "walkMC" which takes all neccesary params for an monte carlo walk
• a virtual member function "walk" which does the same as "walkMC" but substitutes parameters WalkAbortionCriterion and beta of "walkGradient" with members

Author:

: Hannes Kochniß, Daniel Maticzka, Martin Mann

Definition at line 200 of file Walk.hh.

Public Member Functions
virtual StateCollector *	walk (const State *const start, StateCollector *const scWalk, StateCollector *const scRejected=NULL) const
	WalkMC (const WalkAbortionCriterion *const wac, const double beta)
virtual	~WalkMC ()
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 *	walkMC (const State *const start, StateCollector *const scWalk, const WalkAbortionCriterion *const wac, const double kT, StateCollector *const scRejected=NULL)
Protected Attributes
const double	kT
const WalkAbortionCriterion *const	wac

---

Constructor & Destructor Documentation

ell::WalkMC::WalkMC	(	const WalkAbortionCriterion *const	wac,
		const double	beta
	)

constructor which takes an AbortionCriterion and a term beta(1/k*T) TODO (formula correct?) which is used by the StateAcceptor(based on Metropolitan criterion)

Definition at line 196 of file Walk.cc.

virtual ell::WalkMC::~WalkMC

(

)

[inline, virtual]

virtual destructor

Definition at line 209 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, 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

Definition at line 13 of file Walk.cc.

StateCollector * ell::WalkMC::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.

Definition at line 223 of file Walk.cc.

StateCollector * ell::WalkMC::walkMC	(	const State *const	start,
		StateCollector *const	scWalk,
		const WalkAbortionCriterion *const	wac,
		const double	kT,
		StateCollector *const	scRejected = NULL
	)			[static]

Static function for a Monte Carlo walk using the Metropolis criterion parametrized by kT. This is done utilizing a SA_Metropolis state acceptor object based on the Boltzmann weight of the energy difference between States.

Parameters:

	start	the begin of the walk
	scWalk	the StateCollector each step of the walk is added to
	wac	the walk abortion criterion that decides if the end of the walk has been reached or a further step is to do
	kT	kT parameter of metropolis criterion e^(-E(State)/k*T))
	scRejected	the StateCollector each rejected possible step is added to

Returns:

the modified scWalk StateCollector

Definition at line 204 of file Walk.cc.

---

Field Documentation

const double ell::WalkMC::kT [protected]

WalkMC object stores kT used by the virtual walk function to create a SA_Metropolis state acceptor object.

Definition at line 249 of file Walk.hh.

const WalkAbortionCriterion* const ell::WalkMC::wac [protected]

WalkMC object stores the WalkAbortionCriterion used by the virtual walk function.

Definition at line 245 of file Walk.hh.

---

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

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