Tomographer
v5.3
Tomographer C++ Framework Documentation
|
Result of a task run. More...
#include <tomographer/mhrwtasks.h>
Public Types | |
typedef MHRWStatsResultsType_ | MHRWStatsResultsType |
The type which stores the results from the statistics carried out during the random walk. More... | |
typedef MHRWParams< MHWalkerParams, IterCountIntType > | MHRWParamsType |
The type to use to store the parameters of the random walk. | |
Public Member Functions | |
template<typename MHRWStatsResultsTypeInit , typename MHRWParamsTypeInit > | |
MHRandomWalkTaskResult (MHRWStatsResultsTypeInit &&stats_results_, MHRWParamsTypeInit &&mhrw_params_, double acceptance_ratio_) | |
Constructor, initializes fields to the given values. More... | |
template<typename MHRWStatsResultsTypeInit , typename MHRandomWalkType > | |
MHRandomWalkTaskResult (MHRWStatsResultsTypeInit &&stats_results_, const MHRandomWalkType &mhrandomwalk) | |
Constructor with mhrw_params initialized from a random walk instance. More... | |
template<ENABLED_IF( std::is_default_constructible< MHRWStatsResultsType >::value) > | |
MHRandomWalkTaskResult () | |
Construct an invalid object – ONLY for use with Boost.serialization. | |
MHRandomWalkTaskResult (MHRandomWalkTaskResult &&)=default | |
MHRandomWalkTaskResult (const MHRandomWalkTaskResult &)=default | |
Public Attributes | |
MHRWStatsResultsType | stats_results |
The result(s) coming from stats collecting (may be processed, see MHRandomWalkTaskCData Interface) | |
MHRWParamsType | mhrw_params |
The parameters of the random walk (see MHRWParams<MHWalkerParams,IterCountIntType>) | |
double | acceptance_ratio |
The acceptance ratio of the Metropolis-Hastings random walk. | |
Result of a task run.
This is the results from stats collectors, as well as information about the random walk (e.g. acceptance ratio).
MHRWStatsResultsType | The result of the stat collector(s). This type may be any type which can be constructed using the result of the stats collector created by the CData type (see createMHRWTaskComponents() in MHRandomWalkTaskCData Interface). Typically, this is just the ResultType of the MHRWStatsCollector itself which was created by createMHRWTaskComponents(). This type must be default-constructible. |
IterCountIntType | the integer type used for counting iterations in the MHRW task. |
MHWalkerParams | the real type used to describe the step size. |
Definition at line 272 of file mhrwtasks.h.
typedef MHRWStatsResultsType_ Tomographer::MHRWTasks::MHRandomWalkTaskResult< MHRWStatsResultsType_, IterCountIntType, MHWalkerParams >::MHRWStatsResultsType |
The type which stores the results from the statistics carried out during the random walk.
This is given by the first template parameter (see class doc).
Definition at line 279 of file mhrwtasks.h.
|
inline |
Constructor, initializes fields to the given values.
The first parameter is meant to be the ResultType of a MHRWStatsCollector (const reference or temporary); it may be however any type accepted by a one-argument constructor of the ResultType in question (this allows to call either the rvalue-ref constructor or copy constructor automatically).
Definition at line 294 of file mhrwtasks.h.
|
inline |
Constructor with mhrw_params initialized from a random walk instance.
stats_results_ | the MHRWStatsResults result, or an acceptable initializer for that type |
mhrandomwalk | should be a MHRandomWalk instance |
Definition at line 311 of file mhrwtasks.h.