ell::NG_Random::NeighborList Class Reference
#include <NeighborGenerator.hh>
Detailed Description
Definition at line 37 of file NeighborGenerator.hh.
Public Member Functions | |
| virtual State * | first (State::NeighborList::ItState **itstate) const |
| NeighborList (const State *_origin) | |
| virtual State * | next (State::NeighborList::ItState *itstate, State *elem) const |
| virtual | ~NeighborList () |
Protected Attributes | |
| const State *const | origin |
Constructor & Destructor Documentation
| ell::NG_Random::NeighborList::NeighborList | ( | const State * | _origin | ) |
Definition at line 7 of file NeighborGenerator.cc.
| ell::NG_Random::NeighborList::~NeighborList | ( | ) | [virtual] |
Definition at line 11 of file NeighborGenerator.cc.
Member Function Documentation
| State * ell::NG_Random::NeighborList::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 14 of file NeighborGenerator.cc.
| State * ell::NG_Random::NeighborList::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 23 of file NeighborGenerator.cc.
Field Documentation
const State* const ell::NG_Random::NeighborList::origin [protected] |
The documentation for this class was generated from the following files:
- src/ell/NeighborGenerator.hh
- src/ell/NeighborGenerator.cc