Tomographer::MHRWTasks::MHRandomWalkTask< MHRandomWalkTaskCData, Rng >::StatusReport Struct Reference

Status Report for a MHRandomWalkTask. More...

#include <tomographer2/mhrwtasks.h>

Inheritance diagram for Tomographer::MHRWTasks::MHRandomWalkTask< MHRandomWalkTaskCData, Rng >::StatusReport:

Collaboration diagram for Tomographer::MHRWTasks::MHRandomWalkTask< MHRandomWalkTaskCData, Rng >::StatusReport:

Public Member Functions
	StatusReport (double fdone=0.0, const std::string &msg=std::string(), CountIntType 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_)

Public Attributes
CountIntType	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() )
CountIntType	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 MHRandomWalkTaskCData, typename Rng = std::mt19937>
struct Tomographer::MHRWTasks::MHRandomWalkTask< MHRandomWalkTaskCData, Rng >::StatusReport

Status Report for a MHRandomWalkTask.

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

This is for use with, for example, MultiProc::OMP::TaskDispatcher::requestStatusReport().

Definition at line 259 of file mhrwtasks.h.

Member Data Documentation

template<typename MHRandomWalkTaskCData , typename Rng = std::mt19937>

MHRWParamsType Tomographer::MHRWTasks::MHRandomWalkTask< MHRandomWalkTaskCData, Rng >::StatusReport::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 (step_size).

See also MHRandomWalk

Definition at line 284 of file mhrwtasks.h.

template<typename MHRandomWalkTaskCData , typename Rng = std::mt19937>

CountIntType Tomographer::MHRWTasks::MHRandomWalkTask< MHRandomWalkTaskCData, Rng >::StatusReport::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 297 of file mhrwtasks.h.

---

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

• tomographer2/mhrwtasks.h (v2.0)