Tomographer  v1.0a
Tomographer C++ Framework Documentation
Tomographer::ValueHistogramWithBinningMHRWStatsCollector< Params, LoggerType_ > Class Template Reference

Collect a histogram of values from a MH random walk, with binning analysis. More...

#include <tomographer/mhrw.h>

Public Types

typedef Params::ValueCalculator ValueCalculator
 See ValueHistogramWithBinningMHRWStatsCollectorParams::ValueCalculator .
 
typedef Params::CountIntType CountIntType
 See ValueHistogramWithBinningMHRWStatsCollectorParams::CountIntType .
 
typedef Params::CountRealAvgType CountRealAvgType
 See ValueHistogramWithBinningMHRWStatsCollectorParams::CountRealAvgType .
 
typedef LoggerType_ LoggerType
 Somewhere where this object may log what it's doing.
 
typedef Params::BaseHistogramType BaseHistogramType
 See ValueHistogramWithBinningMHRWStatsCollectorParams::BaseHistogramType .
 
typedef Params::HistogramParams HistogramParams
 See ValueHistogramWithBinningMHRWStatsCollectorParams::HistogramParams .
 
typedef Params::ValueType ValueType
 See ValueHistogramWithBinningMHRWStatsCollectorParams::ValueType .
 
typedef Params::BinningAnalysisParamsType BinningAnalysisParamsType
 See ValueHistogramWithBinningMHRWStatsCollectorParams::BinningAnalysisParamsType .
 
typedef BinningAnalysis< BinningAnalysisParamsType, LoggerTypeBinningAnalysisType
 See ValueHistogramWithBinningMHRWStatsCollectorParams::BinningAnalysisType .
 
typedef Params::Result Result
 See ValueHistogramWithBinningMHRWStatsCollectorParams::Result .
 
typedef ValueHistogramMHRWStatsCollector< ValueCalculator, LoggerType, BaseHistogramTypeValueHistogramMHRWStatsCollectorType
 This is the natural ValueHistogramMHRWStatsCollector type on which we're adding error bars.
 

Public Member Functions

 ValueHistogramWithBinningMHRWStatsCollector (HistogramParams histogram_params, const ValueCalculator &vcalc, int num_levels, LoggerType &logger_)
 
const BaseHistogramTypehistogram () const
 Get the histogram data collected so far. See BaseHistogramType .
 
const BinningAnalysisTypeget_binning_analysis () const
 
const ResultgetResult () const
 Get the final histogram data. This method is needed for Resultable Interface compliance. More...
 
void init ()
 Part of the MHRWStatsCollector Interface. Initializes the histogram to zeros.
 
void thermalizing_done ()
 Part of the MHRWStatsCollector Interface. No-op.
 
void done ()
 Finalize the data collection. Part of the MHRWStatsCollector Interface.
 
template<typename CountIntType2 , typename PointType , typename LLHValueType , typename MHRandomWalk >
void raw_move (CountIntType2 k, bool is_thermalizing, bool is_live_iter, bool accepted, double a, const PointType &newpt, LLHValueType newptval, const PointType &curpt, LLHValueType curptval, MHRandomWalk &mh)
 Part of the MHRWStatsCollector Interface. No-op.
 
template<typename CountIntType2 , typename PointType , typename LLHValueType , typename MHRandomWalk >
void process_sample (CountIntType2 k, CountIntType2 n, const PointType &curpt, LLHValueType curptval, MHRandomWalk &mh)
 Part of the MHRWStatsCollector Interface. Records the sample in the histogram.
 

Static Public Attributes

static constexpr int NumTrackValuesCTime = Params::NumTrackValues
 See ValueHistogramWithBinningMHRWStatsCollectorParams::NumTrackValues .
 
static constexpr int NumLevelsCTime = Params::NumLevels
 See ValueHistogramWithBinningMHRWStatsCollectorParams::NumLevels .
 

Detailed Description

template<typename Params, typename LoggerType_ = Logger::VacuumLogger>
class Tomographer::ValueHistogramWithBinningMHRWStatsCollector< Params, LoggerType_ >

Collect a histogram of values from a MH random walk, with binning analysis.

The Params template parameter must be a ValueHistogramWithBinningMHRWStatsCollectorParams with the relevant template parameters.

Definition at line 959 of file mhrw.h.

Member Function Documentation

template<typename Params , typename LoggerType_ = Logger::VacuumLogger>
const Result& Tomographer::ValueHistogramWithBinningMHRWStatsCollector< Params, LoggerType_ >::getResult ( ) const
inline

Get the final histogram data. This method is needed for Resultable Interface compliance.

This will only yield a valid value AFTER the all the data has been collected and done() was called.

Definition at line 1044 of file mhrw.h.


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