ell::SAC_MaxIterations Class Reference
#include <SamplingAbortionCriterion.hh>
Inheritance diagram for ell::SAC_MaxIterations:
Detailed Description
This criterion is used to decide if a sampling process changing a landscape topology should end based on the number of iterations performed. If the maximal number is exceeded abortSampling gives true.
Definition at line 56 of file SamplingAbortionCriterion.hh.
Public Member Functions | |
| virtual bool | abortSampling (const LandscapeTopology *const lt, const bool ltChanged=true) |
| virtual void | reset (void) |
| SAC_MaxIterations (const size_t maxIterations) | |
| virtual | ~SAC_MaxIterations () |
Protected Attributes | |
| size_t | doneIterations |
| const size_t | MAX_ITERATIONS |
Constructor & Destructor Documentation
| ell::SAC_MaxIterations::SAC_MaxIterations | ( | const size_t | maxIterations | ) |
Construction
- Parameters:
-
maxIterations the maximal number of iterations to allow.
Definition at line 19 of file SamplingAbortionCriterion.cc.
| ell::SAC_MaxIterations::~SAC_MaxIterations | ( | ) | [virtual] |
Member Function Documentation
| bool ell::SAC_MaxIterations::abortSampling | ( | const LandscapeTopology *const | lt, | |
| const bool | ltChanged = true | |||
| ) | [virtual] |
Decides whether or not the sampling should be aborted or has to be continued base on the number of iterations performed so far.
- 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
Implements ell::SamplingAbortionCriterion.
Definition at line 36 of file SamplingAbortionCriterion.cc.
| void ell::SAC_MaxIterations::reset | ( | void | ) | [virtual] |
Resets the internal counter of the number of iterations seen so far.
Implements ell::SamplingAbortionCriterion.
Definition at line 48 of file SamplingAbortionCriterion.cc.
Field Documentation
size_t ell::SAC_MaxIterations::doneIterations [protected] |
const size_t ell::SAC_MaxIterations::MAX_ITERATIONS [protected] |
the maximal number of iterations to allow
Definition at line 93 of file SamplingAbortionCriterion.hh.
The documentation for this class was generated from the following files:
- src/ell/SamplingAbortionCriterion.hh
- src/ell/SamplingAbortionCriterion.cc