ppl::MCMCResult< Major > Struct Template Reference

#include <result.hpp>

Public Types
using	cont_samples_t = Eigen::Matrix< util::cont_param_t, Eigen::Dynamic, Eigen::Dynamic, Major >
using	disc_samples_t = Eigen::Matrix< util::disc_param_t, Eigen::Dynamic, Eigen::Dynamic >

Public Member Functions
	MCMCResult ()=default
	MCMCResult (size_t n_samples, size_t n_cont_params, size_t n_disc_params)

Public Attributes
cont_samples_t	cont_samples
disc_samples_t	disc_samples
std::string	name
double	warmup_time = 0
double	sampling_time = 0

Detailed Description

template<int Major = Eigen::ColMajor>
struct ppl::MCMCResult< Major >

MCMC Output object when a sampling algorithm returns. Stores useful information from MCMC sampling routine such as:

• continuous and discrete samples
• warmup and sampling time
• name of mcmc algorithm invoked

Member Typedef Documentation

cont_samples_t

template<int Major = Eigen::ColMajor>

using ppl::MCMCResult< Major >::cont_samples_t = Eigen::Matrix<util::cont_param_t, Eigen::Dynamic, Eigen::Dynamic, Major>

disc_samples_t

template<int Major = Eigen::ColMajor>

using ppl::MCMCResult< Major >::disc_samples_t = Eigen::Matrix<util::disc_param_t, Eigen::Dynamic, Eigen::Dynamic>

Constructor & Destructor Documentation

MCMCResult() [1/2]

template<int Major = Eigen::ColMajor>

ppl::MCMCResult< Major >::MCMCResult ( )

default

MCMCResult() [2/2]

template<int Major = Eigen::ColMajor>

ppl::MCMCResult< Major >::MCMCResult ( size_t  n_samples, size_t  n_cont_params, size_t  n_disc_params  )

inline

Member Data Documentation

cont_samples

template<int Major = Eigen::ColMajor>

cont_samples_t ppl::MCMCResult< Major >::cont_samples

disc_samples

template<int Major = Eigen::ColMajor>

disc_samples_t ppl::MCMCResult< Major >::disc_samples

name

template<int Major = Eigen::ColMajor>

std::string ppl::MCMCResult< Major >::name

sampling_time

template<int Major = Eigen::ColMajor>

double ppl::MCMCResult< Major >::sampling_time = 0

warmup_time

template<int Major = Eigen::ColMajor>

double ppl::MCMCResult< Major >::warmup_time = 0

---

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

• include/autoppl/mcmc/result.hpp