ell::SAC_MaxNoChange Class Reference
#include <SamplingAbortionCriterion.hh>
Inheritance diagram for ell::SAC_MaxNoChange:
Detailed Description
This criterion is used to decide if a sampling process changing a landscape topology should end based on the number of successive iterations where no change was reported. If this number does exeeds a given maximum abortSampling gives true.NOTE: This SAC expects the usage of the ltChanged parameter! Otherwise it will never stop the sampling iteration (return true)!
Definition at line 114 of file SamplingAbortionCriterion.hh.
Public Member Functions | |
| virtual bool | abortSampling (const LandscapeTopology *const lt, const bool ltChanged=true) |
| virtual void | reset (void) |
| SAC_MaxNoChange (const size_t maxNoChangeIterations) | |
| virtual | ~SAC_MaxNoChange () |
Protected Attributes | |
| size_t | iterationsWithoutChange |
| const size_t | MAX_NO_CHANGE_ITERATIONS |
Constructor & Destructor Documentation
| ell::SAC_MaxNoChange::SAC_MaxNoChange | ( | const size_t | maxNoChangeIterations | ) |
Construction
- Parameters:
-
maxNoChangeIterations the maximal number of successive iterations to allow, where no change was reported.
Definition at line 63 of file SamplingAbortionCriterion.cc.
| ell::SAC_MaxNoChange::~SAC_MaxNoChange | ( | ) | [virtual] |
Member Function Documentation
| bool ell::SAC_MaxNoChange::abortSampling | ( | const LandscapeTopology *const | lt, | |
| const bool | ltChanged = true | |||
| ) | [virtual] |
Decides whether or not the sampling should be aborted or has to be continued based on the number of iterations where lt was not changed. If this number has not changed for MAX_NO_CHANGE_ITERATIONS successive iterations the function returns true.
NOTE: This SAC expects the usage of the ltChanged parameter! Otherwise it will never stop the sampling iteration (return true)!
- 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 80 of file SamplingAbortionCriterion.cc.
| void ell::SAC_MaxNoChange::reset | ( | void | ) | [virtual] |
Resets the internal counter of the number of iterations seen so far where no change was reported.
Implements ell::SamplingAbortionCriterion.
Definition at line 97 of file SamplingAbortionCriterion.cc.
Field Documentation
size_t ell::SAC_MaxNoChange::iterationsWithoutChange [protected] |
the number of iterations seen so far where no change was reported
Definition at line 160 of file SamplingAbortionCriterion.hh.
const size_t ell::SAC_MaxNoChange::MAX_NO_CHANGE_ITERATIONS [protected] |
the maximal number of successive iterations without change to allow
Definition at line 158 of file SamplingAbortionCriterion.hh.
The documentation for this class was generated from the following files:
- src/ell/SamplingAbortionCriterion.hh
- src/ell/SamplingAbortionCriterion.cc