ell::StatePairCollector Class Reference
#include <StatePairCollector.hh>
Inheritance diagram for ell::StatePairCollector:
Detailed Description
This abstract interface is used to keep track of visited pairs of states. For instance, it is used during flooding of the landscape to determine the contact planes between basins.
Definition at line 22 of file StatePairCollector.hh.
Public Types | |
| typedef std::pair< const State *, const State * > | StatePair |
Public Member Functions | |
| virtual void | add (const State *const s1, const State *const s2)=0 |
| virtual void | add (const StatePair &s)=0 |
| virtual const StatePair | getLastAdded () const=0 |
| virtual size_t | size () const=0 |
| virtual | ~StatePairCollector () |
Member Typedef Documentation
| typedef std::pair<const State*,const State*> ell::StatePairCollector::StatePair |
Constructor & Destructor Documentation
| virtual ell::StatePairCollector::~StatePairCollector | ( | ) | [inline, virtual] |
Definition at line 30 of file StatePairCollector.hh.
Member Function Documentation
| virtual void ell::StatePairCollector::add | ( | const State *const | s1, | |
| const State *const | s2 | |||
| ) | [pure virtual] |
This function makes the collector manage the given State pair.
Implemented in ell::SPC_Counting, ell::SPC_Listing, ell::SPC_Outstream, and ell::SPC_MinPair.
| virtual void ell::StatePairCollector::add | ( | const StatePair & | s | ) | [pure virtual] |
| virtual const StatePair ell::StatePairCollector::getLastAdded | ( | ) | const [pure virtual] |
Returns last added State pair. Note: The pointed States will be deleted when the collector is destroyed. So a cloning is needed in case the pair will be needed later.
- Returns:
- last added State pair
Implemented in ell::SPC_Counting, and ell::SPC_Listing.
| virtual size_t ell::StatePairCollector::size | ( | ) | const [pure virtual] |
Returns number of added State pairs.
- Returns:
- the number of added state pairs
Implemented in ell::SPC_Counting, and ell::SPC_Listing.
The documentation for this class was generated from the following file:
- src/ell/StatePairCollector.hh