ell::SamplingAbortionCriterion Class Reference
#include <SamplingAbortionCriterion.hh>
Inheritance diagram for ell::SamplingAbortionCriterion:
Detailed Description
This criterion is used to decide if a sampling process changing a landscape topology should end or not.
Definition at line 13 of file SamplingAbortionCriterion.hh.
Public Member Functions | |
| virtual bool | abortSampling (const LandscapeTopology *const lt, const bool ltChanged=true)=0 |
| virtual void | reset (void)=0 |
| virtual | ~SamplingAbortionCriterion () |
Constructor & Destructor Documentation
| ell::SamplingAbortionCriterion::~SamplingAbortionCriterion | ( | ) | [virtual] |
Member Function Documentation
| virtual bool ell::SamplingAbortionCriterion::abortSampling | ( | const LandscapeTopology *const | lt, | |
| const bool | ltChanged = true | |||
| ) | [pure virtual] |
Decides whether or not the sampling should be aborted or has to be continued. This is done based on the current status of the given landscape topology. The additional information that the landscape was changed since the last call of this function can reduce redundant computation and speed up the decision.
- Parameters:
-
lt the landscape topology that is used to decide if the sampling should be aborted or not based on its properties ltChanged whether or not the landscape was changed since the last call of this function
- Returns:
- true if the sampling should be aborted, false otherwise
Implemented in ell::SAC_MaxIterations, ell::SAC_MaxNoChange, and ell::SAC_NoMinimaChange.
| virtual void ell::SamplingAbortionCriterion::reset | ( | void | ) | [pure virtual] |
Resets the internal data structures.
Implemented in ell::SAC_MaxIterations, ell::SAC_MaxNoChange, and ell::SAC_NoMinimaChange.
The documentation for this class was generated from the following files:
- src/ell/SamplingAbortionCriterion.hh
- src/ell/SamplingAbortionCriterion.cc