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_hmc< M, P, H, I, BaseRNG > Class Template Reference

#include <base_hmc.hpp>

Inheritance diagram for stan::mcmc::base_hmc< M, P, H, I, BaseRNG >:
stan::mcmc::base_mcmc stan::mcmc::base_nuts< M, P, H, I, BaseRNG > stan::mcmc::base_static_hmc< M, P, H, I, BaseRNG >

Public Member Functions

 base_hmc (M &m, BaseRNG &rng, std::ostream *o, std::ostream *e)
 
void write_sampler_state (std::ostream *o)
 
void get_sampler_diagnostic_names (std::vector< std::string > &model_names, std::vector< std::string > &names)
 
void get_sampler_diagnostics (std::vector< double > &values)
 
void seed (const Eigen::VectorXd &q)
 
void init_stepsize ()
 
P & z ()
 
virtual void set_nominal_stepsize (const double e)
 
double get_nominal_stepsize ()
 
double get_current_stepsize ()
 
virtual void set_stepsize_jitter (const double j)
 
double get_stepsize_jitter ()
 
void sample_stepsize ()
 
- Public Member Functions inherited from stan::mcmc::base_mcmc
 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)
 

Protected Attributes

P z_
 
I< H< M, BaseRNG >, P > integrator_
 
H< M, BaseRNG > hamiltonian_
 
BaseRNG & rand_int_
 
boost::uniform_01< BaseRNG & > rand_uniform_
 
double nom_epsilon_
 
double epsilon_
 
double epsilon_jitter_
 
- Protected Attributes inherited from stan::mcmc::base_mcmc
std::string name_
 
std::ostream * out_stream_
 
std::ostream * err_stream_
 

Detailed Description

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
class stan::mcmc::base_hmc< M, P, H, I, BaseRNG >

Definition at line 20 of file base_hmc.hpp.

Constructor & Destructor Documentation

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::base_hmc ( M &  m,
BaseRNG &  rng,
std::ostream *  o,
std::ostream *  e 
)
inline

Definition at line 24 of file base_hmc.hpp.

Member Function Documentation

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
double stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::get_current_stepsize ( )
inline

Definition at line 117 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
double stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::get_nominal_stepsize ( )
inline

Definition at line 115 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
void stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::get_sampler_diagnostic_names ( std::vector< std::string > &  model_names,
std::vector< std::string > &  names 
)
inlinevirtual

Reimplemented from stan::mcmc::base_mcmc.

Definition at line 42 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
void stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::get_sampler_diagnostics ( std::vector< double > &  values)
inlinevirtual

Reimplemented from stan::mcmc::base_mcmc.

Definition at line 47 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
double stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::get_stepsize_jitter ( )
inline

Definition at line 123 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
void stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::init_stepsize ( )
inline

Definition at line 55 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
void stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::sample_stepsize ( )
inline

Definition at line 125 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
void stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::seed ( const Eigen::VectorXd &  q)
inline

Definition at line 51 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
virtual void stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::set_nominal_stepsize ( const double  e)
inlinevirtual

Reimplemented in 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 111 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
virtual void stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::set_stepsize_jitter ( const double  j)
inlinevirtual

Definition at line 119 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
void stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::write_sampler_state ( std::ostream *  o)
inlinevirtual

Reimplemented from stan::mcmc::base_mcmc.

Definition at line 36 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
P& stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::z ( )
inline

Definition at line 109 of file base_hmc.hpp.

Member Data Documentation

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
double stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::epsilon_
protected

Definition at line 143 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
double stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::epsilon_jitter_
protected

Definition at line 144 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
H<M, BaseRNG> stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::hamiltonian_
protected

Definition at line 135 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
I<H<M, BaseRNG>, P> stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::integrator_
protected

Definition at line 134 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
double stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::nom_epsilon_
protected

Definition at line 142 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
BaseRNG& stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::rand_int_
protected

Definition at line 137 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
boost::uniform_01<BaseRNG&> stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::rand_uniform_
protected

Definition at line 140 of file base_hmc.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
P stan::mcmc::base_hmc< M, P, H, I, BaseRNG >::z_
protected

Definition at line 133 of file base_hmc.hpp.

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