ell::Basin Class Reference
#include <Basin.hh>
Detailed Description
Wrapper class around the basin algorithm. For a detailed description see static member function Basin::basin(..).
Definition at line 16 of file Basin.hh.
Public Member Functions | |
| Basin (const double maxE, const double deltaE, const size_t maxToStore) | |
| double | flood (const State *const localMin, StateCollector *scBasin, StateCollector *scSurface=NULL) |
Static Public Member Functions | |
| static double | basin (const State *const localMin, StateCollector *scBasin, const double maxE, const double deltaE, const size_t maxToStore, StateCollector *scSurface=NULL) |
Protected Attributes | |
| const double | deltaE |
| const double | maxE |
| const size_t | maxToStore |
Data Structures | |
| class | QueueVal |
| the updatable value stored for a key More... | |
Constructor & Destructor Documentation
| ell::Basin::Basin | ( | const double | maxE, | |
| const double | deltaE, | |||
| const size_t | maxToStore | |||
| ) |
Member Function Documentation
| double ell::Basin::basin | ( | const State *const | localMin, | |
| StateCollector * | scBasin, | |||
| const double | maxE, | |||
| const double | deltaE, | |||
| const size_t | maxToStore, | |||
| StateCollector * | scSurface = NULL | |||
| ) | [static] |
Fills succesivelly the basin of the given local minimum in the landscape and stores the seen States in energy increasing order to the given StateCollector. The basin is flooded up to maxE. Therefore, all neighbored States with energy below maxE have to be stored in a queue. A maximal number of states to store for investigation in parallel can be given by maxToStore. If the underlying queue size exeeds this maxE is decreased for deltaE and all States above the new maxE are removed from the queue. This is repeated until the queue size falls back below maxToStore.
- Parameters:
-
localMin the local minimum the basin belongs to scBasin the StateCollector all states that belong to the gradient basin are written to maxE the maximal energy all states should be below deltaE the delta E to lower maxE in case too many states are in the queue maxToStore the maximal number of elements the underlying queue is allowed to contain scSurface the StateCollector all states that form the surface of the basin (are not part of it) are written to
- Returns:
- the maximal energy until the basin was flooded (all accepted state have energy below)
| double ell::Basin::flood | ( | const State *const | localMin, | |
| StateCollector * | scBasin, | |||
| StateCollector * | scSurface = NULL | |||
| ) |
Calls the static member function Basin::basin(..) with the parameters from construction to flood the gradient basin of localMin, storing all States of the basin in sc.
- 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 StateCollector all states that form the surface of the basin (are not part of it) are written to
- Returns:
- the maximal energy until the basin was flooded (all accepted state have energy below)
Field Documentation
const double ell::Basin::deltaE [protected] |
const double ell::Basin::maxE [protected] |
const size_t ell::Basin::maxToStore [protected] |
The documentation for this class was generated from the following files: