stan::mcmc::base_hamiltonian< M, P, BaseRNG > Class Template Reference

#include <base_hamiltonian.hpp>

Public Member Functions
	base_hamiltonian (M &m, std::ostream *e)
	~base_hamiltonian ()
virtual double	T (P &z)=0
double	V (P &z)
virtual double	tau (P &z)=0
virtual double	phi (P &z)=0
double	H (P &z)
virtual const Eigen::VectorXd	dtau_dq (P &z)=0
virtual const Eigen::VectorXd	dtau_dp (P &z)=0
virtual const Eigen::VectorXd	dphi_dq (P &z)=0
virtual void	sample_p (P &z, BaseRNG &rng)=0
virtual void	init (P &z)
virtual void	update (P &z)

Protected Member Functions
void	write_error_msg_ (std::ostream *error_msgs, const std::exception &e)

Protected Attributes
M &	model_
std::ostream *	err_stream_

Detailed Description

template<typename M, typename P, typename BaseRNG>
class stan::mcmc::base_hamiltonian< M, P, BaseRNG >

Definition at line 17 of file base_hamiltonian.hpp.

Constructor & Destructor Documentation

template<typename M, typename P, typename BaseRNG>

stan::mcmc::base_hamiltonian< M, P, BaseRNG >::base_hamiltonian ( M &  m, std::ostream *  e  )

inline

Definition at line 21 of file base_hamiltonian.hpp.

template<typename M, typename P, typename BaseRNG>

stan::mcmc::base_hamiltonian< M, P, BaseRNG >::~base_hamiltonian ( )

inline

Definition at line 22 of file base_hamiltonian.hpp.

Member Function Documentation

template<typename M, typename P, typename BaseRNG>

virtual const Eigen::VectorXd stan::mcmc::base_hamiltonian< M, P, BaseRNG >::dphi_dq ( P &  z )

pure virtual

Implemented in stan::mcmc::dense_e_metric< M, BaseRNG >, stan::mcmc::diag_e_metric< M, BaseRNG >, and stan::mcmc::unit_e_metric< M, BaseRNG >.

template<typename M, typename P, typename BaseRNG>

virtual const Eigen::VectorXd stan::mcmc::base_hamiltonian< M, P, BaseRNG >::dtau_dp ( P &  z )

pure virtual

Implemented in stan::mcmc::dense_e_metric< M, BaseRNG >, stan::mcmc::diag_e_metric< M, BaseRNG >, and stan::mcmc::unit_e_metric< M, BaseRNG >.

template<typename M, typename P, typename BaseRNG>

virtual const Eigen::VectorXd stan::mcmc::base_hamiltonian< M, P, BaseRNG >::dtau_dq ( P &  z )

pure virtual

Implemented in stan::mcmc::dense_e_metric< M, BaseRNG >, stan::mcmc::diag_e_metric< M, BaseRNG >, and stan::mcmc::unit_e_metric< M, BaseRNG >.

template<typename M, typename P, typename BaseRNG>

double stan::mcmc::base_hamiltonian< M, P, BaseRNG >::H ( P &  z )

inline

Definition at line 30 of file base_hamiltonian.hpp.

template<typename M, typename P, typename BaseRNG>

virtual void stan::mcmc::base_hamiltonian< M, P, BaseRNG >::init ( P &  z )

inlinevirtual

Definition at line 41 of file base_hamiltonian.hpp.

template<typename M, typename P, typename BaseRNG>

virtual double stan::mcmc::base_hamiltonian< M, P, BaseRNG >::phi ( P &  z )

pure virtual

Implemented in stan::mcmc::dense_e_metric< M, BaseRNG >, stan::mcmc::diag_e_metric< M, BaseRNG >, and stan::mcmc::unit_e_metric< M, BaseRNG >.

template<typename M, typename P, typename BaseRNG>

virtual void stan::mcmc::base_hamiltonian< M, P, BaseRNG >::sample_p ( P &  z, BaseRNG &  rng  )

pure virtual

Implemented in stan::mcmc::dense_e_metric< M, BaseRNG >, stan::mcmc::diag_e_metric< M, BaseRNG >, and stan::mcmc::unit_e_metric< M, BaseRNG >.

template<typename M, typename P, typename BaseRNG>

virtual double stan::mcmc::base_hamiltonian< M, P, BaseRNG >::T ( P &  z )

pure virtual

Implemented in stan::mcmc::dense_e_metric< M, BaseRNG >, stan::mcmc::diag_e_metric< M, BaseRNG >, and stan::mcmc::unit_e_metric< M, BaseRNG >.

template<typename M, typename P, typename BaseRNG>

virtual double stan::mcmc::base_hamiltonian< M, P, BaseRNG >::tau ( P &  z )

pure virtual

Implemented in stan::mcmc::dense_e_metric< M, BaseRNG >, stan::mcmc::diag_e_metric< M, BaseRNG >, and stan::mcmc::unit_e_metric< M, BaseRNG >.

template<typename M, typename P, typename BaseRNG>

virtual void stan::mcmc::base_hamiltonian< M, P, BaseRNG >::update ( P &  z )

inlinevirtual

Definition at line 43 of file base_hamiltonian.hpp.

template<typename M, typename P, typename BaseRNG>

double stan::mcmc::base_hamiltonian< M, P, BaseRNG >::V ( P &  z )

inline

Definition at line 25 of file base_hamiltonian.hpp.

template<typename M, typename P, typename BaseRNG>

void stan::mcmc::base_hamiltonian< M, P, BaseRNG >::write_error_msg_ ( std::ostream *  error_msgs, const std::exception &  e  )

inlineprotected

Definition at line 63 of file base_hamiltonian.hpp.

Member Data Documentation

template<typename M, typename P, typename BaseRNG>

std::ostream* stan::mcmc::base_hamiltonian< M, P, BaseRNG >::err_stream_

protected

Definition at line 61 of file base_hamiltonian.hpp.

template<typename M, typename P, typename BaseRNG>

M& stan::mcmc::base_hamiltonian< M, P, BaseRNG >::model_

protected

Definition at line 59 of file base_hamiltonian.hpp.

---

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

• src/stan/mcmc/hmc/hamiltonians/base_hamiltonian.hpp