Stan  2.5.0
probability, sampling & optimization
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
stan::mcmc::base_nuts< M, P, H, I, BaseRNG > Class Template Referenceabstract

#include <base_nuts.hpp>

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

Public Member Functions

 base_nuts (M &m, BaseRNG &rng, std::ostream *o, std::ostream *e)
 
 ~base_nuts ()
 
void set_max_depth (const int d)
 
void set_max_delta (const double d)
 
int get_max_depth ()
 
double get_max_delta ()
 
sample transition (sample &init_sample)
 
void write_sampler_param_names (std::ostream &o)
 
void write_sampler_params (std::ostream &o)
 
void get_sampler_param_names (std::vector< std::string > &names)
 
void get_sampler_params (std::vector< double > &values)
 
virtual bool compute_criterion (ps_point &start, P &finish, Eigen::VectorXd &rho)=0
 
int build_tree (int depth, Eigen::VectorXd &rho, ps_point *z_init_parent, ps_point &z_propose, nuts_util &util)
 
- Public Member Functions inherited from stan::mcmc::base_hmc< M, P, H, I, BaseRNG >
 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 ()
 
std::string name ()
 

Public Attributes

int depth_
 
int max_depth_
 
double max_delta_
 
int n_leapfrog_
 
int n_divergent_
 

Additional Inherited Members

- Protected Attributes inherited from stan::mcmc::base_hmc< M, P, H, I, BaseRNG >
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_nuts< M, P, H, I, BaseRNG >

Definition at line 32 of file base_nuts.hpp.

Constructor & Destructor Documentation

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

Definition at line 37 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::~base_nuts ( )
inline

Definition at line 42 of file base_nuts.hpp.

Member Function Documentation

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
int stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::build_tree ( int  depth,
Eigen::VectorXd &  rho,
ps_point *  z_init_parent,
ps_point &  z_propose,
nuts_util &  util 
)
inline

Definition at line 181 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
virtual bool stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::compute_criterion ( ps_point &  start,
P &  finish,
Eigen::VectorXd &  rho 
)
pure virtual

Implemented in stan::mcmc::dense_e_nuts< M, BaseRNG >, stan::mcmc::diag_e_nuts< M, BaseRNG >, and stan::mcmc::unit_e_nuts< M, BaseRNG >.

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

Definition at line 54 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
int stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::get_max_depth ( )
inline

Definition at line 53 of file base_nuts.hpp.

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

Reimplemented from stan::mcmc::base_mcmc.

Definition at line 164 of file base_nuts.hpp.

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

Reimplemented from stan::mcmc::base_mcmc.

Definition at line 171 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
void stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::set_max_delta ( const double  d)
inline

Definition at line 49 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
void stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::set_max_depth ( const int  d)
inline

Definition at line 44 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
sample stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::transition ( sample &  init_sample)
inlinevirtual

Implements stan::mcmc::base_mcmc.

Definition at line 56 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
void stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::write_sampler_param_names ( std::ostream &  o)
inlinevirtual

Reimplemented from stan::mcmc::base_mcmc.

Definition at line 155 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
void stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::write_sampler_params ( std::ostream &  o)
inlinevirtual

Reimplemented from stan::mcmc::base_mcmc.

Definition at line 159 of file base_nuts.hpp.

Member Data Documentation

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
int stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::depth_

Definition at line 247 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
double stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::max_delta_

Definition at line 249 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
int stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::max_depth_

Definition at line 248 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
int stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::n_divergent_

Definition at line 252 of file base_nuts.hpp.

template<class M, class P, template< class, class > class H, template< class, class > class I, class BaseRNG>
int stan::mcmc::base_nuts< M, P, H, I, BaseRNG >::n_leapfrog_

Definition at line 251 of file base_nuts.hpp.

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