ell::SuccessiveNeighborList Class Reference
#include <IterableNeighbors.hh>
Detailed Description
A generic NeighborList based on the IterableNeighbors interface that successively generates all neighbors of a given state.
Definition at line 62 of file IterableNeighbors.hh.
Public Member Functions | |
| virtual State * | first (State::NeighborList::ItState **itstate) const |
| virtual State * | next (State::NeighborList::ItState *itstate, State *const elem) const |
| SuccessiveNeighborList (const IterableNeighbors *source_) | |
| virtual | ~SuccessiveNeighborList () |
Protected Attributes | |
| const IterableNeighbors * | source |
Data Structures | |
| class | ItState |
| encodes the last neighbor index used More... | |
Constructor & Destructor Documentation
| ell::SuccessiveNeighborList::SuccessiveNeighborList | ( | const IterableNeighbors * | source_ | ) |
Definition at line 9 of file IterableNeighbors.cc.
| ell::SuccessiveNeighborList::~SuccessiveNeighborList | ( | ) | [virtual] |
Definition at line 13 of file IterableNeighbors.cc.
Member Function Documentation
| State * ell::SuccessiveNeighborList::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 41 of file IterableNeighbors.cc.
| State * ell::SuccessiveNeighborList::next | ( | State::NeighborList::ItState * | itstate, | |
| State *const | 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 17 of file IterableNeighbors.cc.
Field Documentation
const IterableNeighbors* ell::SuccessiveNeighborList::source [protected] |
Definition at line 65 of file IterableNeighbors.hh.
The documentation for this class was generated from the following files:
- src/ell/IterableNeighbors.hh
- src/ell/IterableNeighbors.cc