Tomographer  v5.4
Tomographer C++ Framework Documentation
Tomographer::MHRWParams< MHWalkerParams_, CountIntType_ > Struct Template Reference

Specify the parameters of a Metropolis-Hastings random walk. More...

#include <tomographer/mhrw.h>

+ Inheritance diagram for Tomographer::MHRWParams< MHWalkerParams_, CountIntType_ >:
+ Collaboration diagram for Tomographer::MHRWParams< MHWalkerParams_, CountIntType_ >:

Public Types

typedef MHWalkerParams_ MHWalkerParams
 
typedef CountIntType_ CountIntType
 

Public Member Functions

 MHRWParams ()
 default constructor – sets values to zero and default-initializes the mhwalker_params
 
template<typename MHWalkerParamsInit >
 MHRWParams (MHWalkerParamsInit &&mhwalker_params_, CountIntType n_sweep_, CountIntType n_therm_, CountIntType n_run_)
 standard constructor – initializes fields to given values More...
 
template<typename MHWalkerParamsOtherType , typename CountIntOtherType >
 MHRWParams (const MHRWParams< MHWalkerParamsOtherType, CountIntOtherType > &copy)
 copy constructor
 

Public Attributes

MHWalkerParams mhwalker_params
 The parameters of the mh-walker, typically just the step size of the random walk.
 
CountIntType n_sweep
 The number of individual updates to collect together in a "sweep".
 
CountIntType n_therm
 Number of thermalization sweeps.
 
CountIntType n_run
 Number of live sweeps.
 

Detailed Description

template<typename MHWalkerParams_ = MHWalkerParamsStepSize<double>, typename CountIntType_ = int>
struct Tomographer::MHRWParams< MHWalkerParams_, CountIntType_ >

Specify the parameters of a Metropolis-Hastings random walk.

Specifies the parameters of a Metropolis-Hastings random walk (number of thermalization runs, sweep size, number of live runs, step size).

Since
Changed in Tomographer 5.0: This class now stores an arbitrary type for the parameters of the MHWalker type. Note the new template parameter order!!
Since Tomographer 5.3, this class can be serialized with Boost.Serialization as long as MHWalkerParams can be serialized.

Definition at line 135 of file mhrw.h.

Constructor & Destructor Documentation

§ MHRWParams()

template<typename MHWalkerParams_ = MHWalkerParamsStepSize<double>, typename CountIntType_ = int>
template<typename MHWalkerParamsInit >
Tomographer::MHRWParams< MHWalkerParams_, CountIntType_ >::MHRWParams ( MHWalkerParamsInit &&  mhwalker_params_,
CountIntType  n_sweep_,
CountIntType  n_therm_,
CountIntType  n_run_ 
)
inline

standard constructor – initializes fields to given values

The first argument may be anything which can be forwarded to the constructor of mhwalker_params.

Definition at line 154 of file mhrw.h.


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