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, CountIntType n_sweep_=0, CountIntType n_therm_=0, CountIntType n_run_=0, double acceptance_ratio_=0.0)
	Constructor which initializes all fields.

Public Member Functions inherited from Tomographer::MultiProc::StatusReport
	StatusReport (double fraction_done_, const std::string &msg_)

Public Attributes
CountIntType	kstep
	the current iteration number

CountIntType	n_sweep
	the number of iterations that form a sweep (see MHRandomWalk)

CountIntType	n_therm
	the number of thermalization sweeps (see MHRandomWalk)

CountIntType	n_run
	the number of live run sweeps (see MHRandomWalk)

double	acceptance_ratio
	the current acceptance ratio of the random walk (see Tomographer::MHRandomWalk::acceptance_ratio() )

CountIntType	n_total_iters
	the total number of iterations required for this random walk More...

Public Attributes inherited from Tomographer::MultiProc::StatusReport
double	fraction_done

std::string	msg

Detailed Description

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, OMPTaskDispatcher::request_status_report().

Definition at line 179 of file mhrwtasks.h.

Member Data Documentation

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 213 of file mhrwtasks.h.

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