Tomographer::MHRWStatusReport< MHRWParamsType > Struct Template Reference

Status Report structure representing the status of a MHRandomWalk. More...

#include <tomographer/mhrw.h>

Inheritance diagram for Tomographer::MHRWStatusReport< MHRWParamsType >:

Collaboration diagram for Tomographer::MHRWStatusReport< MHRWParamsType >:

Public Types
typedef MHRWParamsType::CountIntType	IterCountIntType

Public Member Functions
	MHRWStatusReport (double fdone=0.0, const std::string &msg=std::string(), IterCountIntType kstep_=0, MHRWParamsType mhrw_params_=MHRWParamsType(), double acceptance_ratio_=0.0)
	Constructor which initializes all fields.
Public Member Functions inherited from Tomographer::MultiProc::TaskStatusReport
	TaskStatusReport (double fraction_done_, std::string msg_)

Static Public Member Functions
template<typename MHRandomWalkType , typename MHRWStatsCollectorType , typename MHRWControllerType >
static MHRWStatusReport	createFromRandWalkStatInfo (IterCountIntType k, bool is_thermalizing, const MHRandomWalkType &rw, const MHRWStatsCollectorType &stats_collector, const MHRWControllerType &mhrw_controller)

Public Attributes
IterCountIntType	kstep
	the current iteration number
MHRWParamsType	mhrw_params
	the parameters of the random walk More...
double	acceptance_ratio
	the current acceptance ratio of the random walk (see Tomographer::MHRandomWalk::acceptanceRatio() )
IterCountIntType	n_total_iters
	the total number of iterations required for this random walk More...
Public Attributes inherited from Tomographer::MultiProc::TaskStatusReport
double	fraction_done
std::string	msg

Detailed Description

template<typename MHRWParamsType>
struct Tomographer::MHRWStatusReport< MHRWParamsType >

Status Report structure representing the status of a MHRandomWalk.

This struct can store information about the current status of a MHRandomWalk while it is running.

This is particularly useful when multiprocessing tasks, for example, with MultiProc::OMP::TaskDispatcher and requesting status reports as with MultiProc::OMP::TaskDispatcher::requestStatusReport().

Definition at line 1142 of file mhrw.h.

Member Data Documentation

mhrw_params

template<typename MHRWParamsType >

MHRWParamsType Tomographer::MHRWStatusReport< MHRWParamsType >::mhrw_params

the parameters of the random walk

Stores the number of iterations that form a sweep (n_sweep), the total number of thermalization sweeps (n_therm), the total number of live run sweeps (n_run) as well as the step size of the random walk (mhwalker_params).

See also MHRandomWalk

Definition at line 1169 of file mhrw.h.

n_total_iters

template<typename MHRWParamsType >

IterCountIntType Tomographer::MHRWStatusReport< MHRWParamsType >::n_total_iters

the total number of iterations required for this random walk

This is calculated as \( \textit{nTotalIters} = \textit{nSweep} \times \left( \textit{nTherm} + \textit{nRun} \right) \).

Definition at line 1182 of file mhrw.h.

---

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

• tomographer/mhrw.h (v5.3)