ell::NeighborGenerator Class Reference
#include <NeighborGenerator.hh>
Inheritance diagram for ell::NeighborGenerator:
Detailed Description
This abstract class is used by all classes generating lists of neighbors.
Definition at line 13 of file NeighborGenerator.hh.
Public Member Functions | |
| virtual State::NeighborListPtr | getNeighborList (const State *const s) const=0 |
| virtual | ~NeighborGenerator () |
Constructor & Destructor Documentation
| virtual ell::NeighborGenerator::~NeighborGenerator | ( | ) | [inline, virtual] |
Definition at line 17 of file NeighborGenerator.hh.
Member Function Documentation
| virtual State::NeighborListPtr ell::NeighborGenerator::getNeighborList | ( | const State *const | s | ) | const [pure virtual] |
Returns a NeighborListPtr to a list of neighbors to State s.
- Parameters:
-
s generate neighbors to this state
- Returns:
- autopointer to generated NeigborList
Implemented in ell::NG_Random, ell::NG_SuccessiveRandom, and ell::NG_Successive.
The documentation for this class was generated from the following file:
- src/ell/NeighborGenerator.hh