Tomographer  v5.4
Tomographer C++ Framework Documentation
Tomographer::MHRWValueErrorBinsConvergedController< ValueHistogramWithBinningMHRWStatsCollectorType_, IterCountIntType_, BaseLoggerType_ > Class Template Reference

A MHRWController Interface which stops the random walk after enough samples have been taken to make all bins of a histogram have converged error bars. More...

#include <tomographer/mhrwvalueerrorbinsconvergedcontroller.h>

Public Types

enum  
 
typedef ValueHistogramWithBinningMHRWStatsCollectorType_ ValueHistogramWithBinningMHRWStatsCollectorType
 
typedef IterCountIntType_ IterCountIntType
 
typedef BaseLoggerType_ BaseLoggerType
 

Public Member Functions

 MHRWValueErrorBinsConvergedController (const ValueHistogramWithBinningMHRWStatsCollectorType &value_stats_collector_, BaseLoggerType &baselogger_, IterCountIntType check_frequency_sweeps_=1024, Eigen::Index max_allowed_unknown_=0, Eigen::Index max_allowed_unknown_notisolated_=0, Eigen::Index max_allowed_not_converged_=0, double max_add_run_iters_=1.5)
 Constructor. More...
 
template<typename MHRWParamsType , typename MHWalker , typename MHRandomWalkType >
void init (MHRWParamsType &, const MHWalker &, const MHRandomWalkType &) const
 
template<typename MHRWParamsType , typename MHWalker , typename CountIntType , typename MHRandomWalkType >
bool allowDoneThermalization (const MHRWParamsType &, const MHWalker &, CountIntType, const MHRandomWalkType &) const
 
template<typename MHRWParamsType , typename MHWalker , typename MHRandomWalkType >
bool allowDoneRuns (const MHRWParamsType &params, const MHWalker &, IterCountIntType iter_k, const MHRandomWalkType &)
 
template<typename MHRWParamsType , typename MHWalker , typename MHRandomWalkType >
void thermalizingDone (const MHRWParamsType &, const MHWalker &, const MHRandomWalkType &) const
 
template<typename MHRWParamsType , typename MHWalker , typename MHRandomWalkType >
void done (MHRWParamsType &, const MHWalker &, const MHRandomWalkType &) const
 

Detailed Description

template<typename ValueHistogramWithBinningMHRWStatsCollectorType_, typename IterCountIntType_, typename BaseLoggerType_>
class Tomographer::MHRWValueErrorBinsConvergedController< ValueHistogramWithBinningMHRWStatsCollectorType_, IterCountIntType_, BaseLoggerType_ >

A MHRWController Interface which stops the random walk after enough samples have been taken to make all bins of a histogram have converged error bars.

Todo:
...... DOC ..............

Definition at line 69 of file mhrwvalueerrorbinsconvergedcontroller.h.

Constructor & Destructor Documentation

§ MHRWValueErrorBinsConvergedController()

template<typename ValueHistogramWithBinningMHRWStatsCollectorType_ , typename IterCountIntType_ , typename BaseLoggerType_ >
Tomographer::MHRWValueErrorBinsConvergedController< ValueHistogramWithBinningMHRWStatsCollectorType_, IterCountIntType_, BaseLoggerType_ >::MHRWValueErrorBinsConvergedController ( const ValueHistogramWithBinningMHRWStatsCollectorType &  value_stats_collector_,
BaseLoggerType &  baselogger_,
IterCountIntType  check_frequency_sweeps_ = 1024,
Eigen::Index  max_allowed_unknown_ = 0,
Eigen::Index  max_allowed_unknown_notisolated_ = 0,
Eigen::Index  max_allowed_not_converged_ = 0,
double  max_add_run_iters_ = 1.5 
)
inline

Constructor.

Note: You may disable the controller entirely by setting check_frequency_sweeps=0.

Definition at line 104 of file mhrwvalueerrorbinsconvergedcontroller.h.


The documentation for this class was generated from the following file: