Generated on Tue Dec 16 13:34:53 2008 for ell-3.0.0 by doxygen 1.5.1

ell::RandomNeighborList Class Reference

#include <IterableNeighbors.hh>


Detailed Description

A generic NeighborList based on the IterableNeighbors interface that randomly generates all neighbors of a given state.

Author:
Martin Mann

Definition at line 106 of file IterableNeighbors.hh.

Public Member Functions

virtual Statefirst (State::NeighborList::ItState **itstate) const
virtual Statenext (State::NeighborList::ItState *itstate, State *elem) const
 RandomNeighborList (const IterableNeighbors *source)
virtual ~RandomNeighborList ()

Protected Attributes

std::vector< size_t > idx2apply
const IterableNeighborssource

Data Structures

class  ItState
 encodes the last neighbor index used More...


Constructor & Destructor Documentation

ell::RandomNeighborList::RandomNeighborList ( const IterableNeighbors source  ) 

Definition at line 70 of file IterableNeighbors.cc.

ell::RandomNeighborList::~RandomNeighborList (  )  [virtual]

Definition at line 82 of file IterableNeighbors.cc.


Member Function Documentation

State * ell::RandomNeighborList::first ( State::NeighborList::ItState **  itstate  )  const [virtual]

Returns a pointer to the first element of the virtual list of neighbors of the state of origin. Returns NULL if no neighbors exist.

Parameters:
itstate constains state of the list iterator
Returns:
first element of NeighborList

Definition at line 109 of file IterableNeighbors.cc.

State * ell::RandomNeighborList::next ( State::NeighborList::ItState itstate,
State elem 
) const [virtual]

Returns a pointer to the next element of the virtual list of neighbors of the state of origin. Returns NULL if no more neighbors exist.

Parameters:
itstate constains state of the list iterator
elem this State is used for the next neighbor
Returns:
next element in NeighborList

Definition at line 86 of file IterableNeighbors.cc.


Field Documentation

std::vector<size_t> ell::RandomNeighborList::idx2apply [protected]

Definition at line 110 of file IterableNeighbors.hh.

Definition at line 109 of file IterableNeighbors.hh.


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