Stan  2.5.0
probability, sampling & optimization
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
stan::mcmc::base_mcmc Class Referenceabstract

#include <base_mcmc.hpp>

Inheritance diagram for stan::mcmc::base_mcmc:
stan::mcmc::base_hmc< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG > stan::mcmc::base_hmc< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG > stan::mcmc::base_hmc< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG > stan::mcmc::base_hmc< M, P, H, I, BaseRNG > stan::mcmc::fixed_param_sampler stan::mcmc::base_nuts< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG > stan::mcmc::base_static_hmc< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG > stan::mcmc::base_nuts< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG > stan::mcmc::base_static_hmc< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG > stan::mcmc::base_nuts< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG > stan::mcmc::base_static_hmc< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG > stan::mcmc::base_nuts< M, P, H, I, BaseRNG > stan::mcmc::base_static_hmc< M, P, H, I, BaseRNG >

Public Member Functions

 base_mcmc (std::ostream *o, std::ostream *e)
 
virtual ~base_mcmc ()
 
virtual sample transition (sample &init_sample)=0
 
std::string name ()
 
virtual void write_sampler_param_names (std::ostream &o)
 
virtual void write_sampler_params (std::ostream &o)
 
virtual void get_sampler_param_names (std::vector< std::string > &names)
 
virtual void get_sampler_params (std::vector< double > &values)
 
virtual void write_sampler_state (std::ostream *o)
 
virtual void get_sampler_diagnostic_names (std::vector< std::string > &model_names, std::vector< std::string > &names)
 
virtual void get_sampler_diagnostics (std::vector< double > &values)
 

Protected Attributes

std::string name_
 
std::ostream * out_stream_
 
std::ostream * err_stream_
 

Detailed Description

Definition at line 13 of file base_mcmc.hpp.

Constructor & Destructor Documentation

stan::mcmc::base_mcmc::base_mcmc ( std::ostream *  o,
std::ostream *  e 
)
inline

Definition at line 17 of file base_mcmc.hpp.

virtual stan::mcmc::base_mcmc::~base_mcmc ( )
inlinevirtual

Definition at line 19 of file base_mcmc.hpp.

Member Function Documentation

virtual void stan::mcmc::base_mcmc::get_sampler_diagnostic_names ( std::vector< std::string > &  model_names,
std::vector< std::string > &  names 
)
inlinevirtual

Reimplemented in stan::mcmc::base_hmc< M, P, H, I, BaseRNG >, stan::mcmc::base_hmc< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_hmc< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, and stan::mcmc::base_hmc< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >.

Definition at line 35 of file base_mcmc.hpp.

virtual void stan::mcmc::base_mcmc::get_sampler_diagnostics ( std::vector< double > &  values)
inlinevirtual

Reimplemented in stan::mcmc::base_hmc< M, P, H, I, BaseRNG >, stan::mcmc::base_hmc< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_hmc< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, and stan::mcmc::base_hmc< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >.

Definition at line 38 of file base_mcmc.hpp.

virtual void stan::mcmc::base_mcmc::get_sampler_param_names ( std::vector< std::string > &  names)
inlinevirtual

Reimplemented in stan::mcmc::base_nuts< M, P, H, I, BaseRNG >, stan::mcmc::base_nuts< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_nuts< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_nuts< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_static_hmc< M, P, H, I, BaseRNG >, stan::mcmc::base_static_hmc< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_static_hmc< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, and stan::mcmc::base_static_hmc< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >.

Definition at line 29 of file base_mcmc.hpp.

virtual void stan::mcmc::base_mcmc::get_sampler_params ( std::vector< double > &  values)
inlinevirtual

Reimplemented in stan::mcmc::base_nuts< M, P, H, I, BaseRNG >, stan::mcmc::base_nuts< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_nuts< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_nuts< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_static_hmc< M, P, H, I, BaseRNG >, stan::mcmc::base_static_hmc< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_static_hmc< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, and stan::mcmc::base_static_hmc< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >.

Definition at line 31 of file base_mcmc.hpp.

std::string stan::mcmc::base_mcmc::name ( )
inline

Definition at line 23 of file base_mcmc.hpp.

virtual sample stan::mcmc::base_mcmc::transition ( sample &  init_sample)
pure virtual

Implemented in stan::mcmc::base_nuts< M, P, H, I, BaseRNG >, stan::mcmc::base_nuts< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_nuts< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_nuts< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::adapt_dense_e_static_hmc< M, BaseRNG >, stan::mcmc::adapt_diag_e_static_hmc< M, BaseRNG >, stan::mcmc::adapt_dense_e_nuts< M, BaseRNG >, stan::mcmc::adapt_diag_e_nuts< M, BaseRNG >, stan::mcmc::adapt_unit_e_static_hmc< M, BaseRNG >, stan::mcmc::base_static_hmc< M, P, H, I, BaseRNG >, stan::mcmc::base_static_hmc< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_static_hmc< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_static_hmc< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::adapt_unit_e_nuts< M, BaseRNG >, and stan::mcmc::fixed_param_sampler.

virtual void stan::mcmc::base_mcmc::write_sampler_param_names ( std::ostream &  o)
inlinevirtual

Reimplemented in stan::mcmc::base_nuts< M, P, H, I, BaseRNG >, stan::mcmc::base_nuts< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_nuts< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_nuts< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_static_hmc< M, P, H, I, BaseRNG >, stan::mcmc::base_static_hmc< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_static_hmc< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, and stan::mcmc::base_static_hmc< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >.

Definition at line 25 of file base_mcmc.hpp.

virtual void stan::mcmc::base_mcmc::write_sampler_params ( std::ostream &  o)
inlinevirtual

Reimplemented in stan::mcmc::base_nuts< M, P, H, I, BaseRNG >, stan::mcmc::base_nuts< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_nuts< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_nuts< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_static_hmc< M, P, H, I, BaseRNG >, stan::mcmc::base_static_hmc< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_static_hmc< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, and stan::mcmc::base_static_hmc< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >.

Definition at line 27 of file base_mcmc.hpp.

virtual void stan::mcmc::base_mcmc::write_sampler_state ( std::ostream *  o)
inlinevirtual

Reimplemented in stan::mcmc::base_hmc< M, P, H, I, BaseRNG >, stan::mcmc::base_hmc< M, diag_e_point, diag_e_metric, expl_leapfrog, BaseRNG >, stan::mcmc::base_hmc< M, dense_e_point, dense_e_metric, expl_leapfrog, BaseRNG >, and stan::mcmc::base_hmc< M, unit_e_point, unit_e_metric, expl_leapfrog, BaseRNG >.

Definition at line 33 of file base_mcmc.hpp.

Member Data Documentation

std::ostream* stan::mcmc::base_mcmc::err_stream_
protected

Definition at line 45 of file base_mcmc.hpp.

std::string stan::mcmc::base_mcmc::name_
protected

Definition at line 38 of file base_mcmc.hpp.

std::ostream* stan::mcmc::base_mcmc::out_stream_
protected

Definition at line 44 of file base_mcmc.hpp.

The documentation for this class was generated from the following file:
     [ Stan Home Page ] © 2011–2014, Stan Development Team.