Tomographer::MHRWTasks::MHRandomWalkTaskResult< MHRWStatsCollectorResultType_, IterCountIntType, StepRealType > Struct Template Reference
Result of a task run. More...
#include <tomographer/mhrwtasks.h>
Inheritance diagram for Tomographer::MHRWTasks::MHRandomWalkTaskResult< MHRWStatsCollectorResultType_, IterCountIntType, StepRealType >: Collaboration diagram for Tomographer::MHRWTasks::MHRandomWalkTaskResult< MHRWStatsCollectorResultType_, IterCountIntType, StepRealType >:Public Types | |
| typedef MHRWStatsCollectorResultType_ | MHRWStatsCollectorResultType |
| The specified result type of the MHRWStatsCollector the task will be looking at. | |
| typedef MHRWParams< IterCountIntType, StepRealType > | MHRWParamsType |
| The type to use to store the parameters of the random walk. | |
Public Member Functions | |
| MHRandomWalkTaskResult () | |
| Construct an empty task result. More... | |
| template<typename MHRWStatsCollectorResultTypeInit , typename MHRWParamsType2 > | |
| MHRandomWalkTaskResult (MHRWStatsCollectorResultTypeInit &&stats_collector_result_, MHRWParamsType2 &&mhrw_params_, double acceptance_ratio_) | |
| Constructor, initializes fields to the given values. More... | |
| template<typename MHRWStatsCollectorResultTypeInit , typename MHRandomWalkType > | |
| MHRandomWalkTaskResult (MHRWStatsCollectorResultTypeInit &&stats_collector_result_, const MHRandomWalkType &mhrandomwalk) | |
| Constructor with mhrw_params initialized from a random walk instance. More... | |
Public Attributes | |
| const MHRWStatsCollectorResultType | stats_collector_result |
| The result furnished by the stats collector itself. | |
| const MHRWParamsType | mhrw_params |
| The parameters of the random walk (see MHRWParams<IterCountIntType,StepRealType>) | |
| const double | acceptance_ratio |
| The acceptance ratio of the Metropolis-Hastings random walk. | |
Detailed Description
template<typename MHRWStatsCollectorResultType_, typename IterCountIntType, typename StepRealType>
struct Tomographer::MHRWTasks::MHRandomWalkTaskResult< MHRWStatsCollectorResultType_, IterCountIntType, StepRealType >
Result of a task run.
This is the stats collector's result, as well as information about the random walk (e.g. acceptance ratio).
- Template Parameters
-
MHRWStatsCollectorResultType_ the result type of the MHRWStatsCollector which the task will be running. IterCountIntType the integer type used for counting iterations in the MHRW task. StepRealType the real type used to describe the step size.
Definition at line 162 of file mhrwtasks.h.
Constructor & Destructor Documentation
§ MHRandomWalkTaskResult() [1/3]
template<typename MHRWStatsCollectorResultType_, typename IterCountIntType, typename StepRealType>
|
inline |
Construct an empty task result.
Definition at line 176 of file mhrwtasks.h.
§ MHRandomWalkTaskResult() [2/3]
template<typename MHRWStatsCollectorResultType_, typename IterCountIntType, typename StepRealType>
template<typename MHRWStatsCollectorResultTypeInit , typename MHRWParamsType2 >
|
inline |
Constructor, initializes fields to the given values.
The first parameter is meant to be a MHRWStatsCollectorResultType const reference or temporary; it may be however any type accepted by a one-argument constructor of MHRWStatsCollectorResultType (this allows to call either the rvalue-ref constructor or copy constructor automatically).
Definition at line 191 of file mhrwtasks.h.
§ MHRandomWalkTaskResult() [3/3]
template<typename MHRWStatsCollectorResultType_, typename IterCountIntType, typename StepRealType>
template<typename MHRWStatsCollectorResultTypeInit , typename MHRandomWalkType >
|
inline |
Constructor with mhrw_params initialized from a random walk instance.
- Parameters
-
stats_collector_result_ the stats-collector result mhrandomwalk should be a MHRandomWalk instance
Definition at line 206 of file mhrwtasks.h.
The documentation for this struct was generated from the following file:
- tomographer/mhrwtasks.h (v4.0)