ell::Basin Class Reference
#include <Basin.hh>
Inheritance diagram for ell::Basin:
Detailed Description
Enumerates the gradient basin of a local minimum and the State pairs that form the contact/surface planes around the basin.A state X belongs to the basin of minimum M if the gradient walk starting in X ends in M. Thus a basin is a set of States containing at least the minimum M.
The contact/surface plane of the basin B is a set of State pairs (X,Y) with
- X and Y are neighbored and
- X is element of the basin B and Y is NOT.
Definition at line 27 of file Basin.hh.
Public Member Functions | |
| virtual double | enumerate (const State *const localMin, StateCollector *scBasin, StatePairCollector *scSurface=NULL)=0 |
| virtual | ~Basin () |
Constructor & Destructor Documentation
Member Function Documentation
| virtual double ell::Basin::enumerate | ( | const State *const | localMin, | |
| StateCollector * | scBasin, | |||
| StatePairCollector * | scSurface = NULL | |||
| ) | [pure virtual] |
Enumerates the gradient basin of a local minimum and stores all found States of the basin and the seen States of the basin surface that are not part of the basin in the given collectors.
- Parameters:
-
localMin the local minimum the basin belongs to scBasin the StateCollector all states that belong to the gradient basin are written to scSurface the StatePairCollector all states that form the contact surface of the basin are written to. The first reported State is part of the basin, the second not.
- Returns:
- the maximal energy until the basin was flooded (all accepted state have energy below)
Implemented in ell::Basin_FME, and ell::Basin_F.
The documentation for this class was generated from the following files: