stan::mcmc::base_hamiltonian< Model, Point, BaseRNG > Class Template Reference

#include <base_hamiltonian.hpp>

Public Types
typedef Point	PointType

Public Member Functions
	base_hamiltonian (const Model &model)
	~base_hamiltonian ()
virtual double	T (Point &z)=0
double	V (Point &z)
virtual double	tau (Point &z)=0
virtual double	phi (Point &z)=0
double	H (Point &z)
virtual double	dG_dt (Point &z, interface_callbacks::writer::base_writer &info_writer, interface_callbacks::writer::base_writer &error_writer)=0
virtual Eigen::VectorXd	dtau_dq (Point &z, interface_callbacks::writer::base_writer &info_writer, interface_callbacks::writer::base_writer &error_writer)=0
virtual Eigen::VectorXd	dtau_dp (Point &z)=0
virtual Eigen::VectorXd	dphi_dq (Point &z, interface_callbacks::writer::base_writer &info_writer, interface_callbacks::writer::base_writer &error_writer)=0
virtual void	sample_p (Point &z, BaseRNG &rng)=0
void	init (Point &z, interface_callbacks::writer::base_writer &info_writer, interface_callbacks::writer::base_writer &error_writer)
void	update_potential (Point &z, interface_callbacks::writer::base_writer &info_writer, interface_callbacks::writer::base_writer &error_writer)
void	update_potential_gradient (Point &z, interface_callbacks::writer::base_writer &info_writer, interface_callbacks::writer::base_writer &error_writer)
void	update_metric (Point &z, interface_callbacks::writer::base_writer &info_writer, interface_callbacks::writer::base_writer &error_writer)
void	update_metric_gradient (Point &z, interface_callbacks::writer::base_writer &info_writer, interface_callbacks::writer::base_writer &error_writer)
void	update_gradients (Point &z, interface_callbacks::writer::base_writer &info_writer, interface_callbacks::writer::base_writer &error_writer)

Protected Member Functions
void	write_error_msg_ (const std::exception &e, interface_callbacks::writer::base_writer &writer)

Protected Attributes
const Model &	model_

Detailed Description

template<class Model, class Point, class BaseRNG>
class stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >

Definition at line 17 of file base_hamiltonian.hpp.

Member Typedef Documentation

PointType

template<class Model, class Point, class BaseRNG>

typedef Point stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::PointType

Definition at line 24 of file base_hamiltonian.hpp.

Constructor & Destructor Documentation

base_hamiltonian()

template<class Model, class Point, class BaseRNG>

stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::base_hamiltonian ( const Model &  model )

inlineexplicit

Definition at line 19 of file base_hamiltonian.hpp.

~base_hamiltonian()

template<class Model, class Point, class BaseRNG>

stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::~base_hamiltonian ( )

inline

Definition at line 22 of file base_hamiltonian.hpp.

Member Function Documentation

dG_dt()

template<class Model, class Point, class BaseRNG>

virtual double stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::dG_dt ( Point &  z, interface_callbacks::writer::base_writer &  info_writer, interface_callbacks::writer::base_writer &  error_writer  )

pure virtual

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

dphi_dq()

template<class Model, class Point, class BaseRNG>

virtual Eigen::VectorXd stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::dphi_dq ( Point &  z, interface_callbacks::writer::base_writer &  info_writer, interface_callbacks::writer::base_writer &  error_writer  )

pure virtual

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

dtau_dp()

template<class Model, class Point, class BaseRNG>

virtual Eigen::VectorXd stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::dtau_dp ( Point &  z )

pure virtual

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

dtau_dq()

template<class Model, class Point, class BaseRNG>

virtual Eigen::VectorXd stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::dtau_dq ( Point &  z, interface_callbacks::writer::base_writer &  info_writer, interface_callbacks::writer::base_writer &  error_writer  )

pure virtual

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

H()

template<class Model, class Point, class BaseRNG>

double stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::H ( Point &  z )

inline

Definition at line 36 of file base_hamiltonian.hpp.

init()

template<class Model, class Point, class BaseRNG>

void stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::init ( Point &  z, interface_callbacks::writer::base_writer &  info_writer, interface_callbacks::writer::base_writer &  error_writer  )

inline

Definition at line 62 of file base_hamiltonian.hpp.

phi()

template<class Model, class Point, class BaseRNG>

virtual double stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::phi ( Point &  z )

pure virtual

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

sample_p()

template<class Model, class Point, class BaseRNG>

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

pure virtual

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

T()

template<class Model, class Point, class BaseRNG>

virtual double stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::T ( Point &  z )

pure virtual

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

tau()

template<class Model, class Point, class BaseRNG>

virtual double stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::tau ( Point &  z )

pure virtual

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

update_gradients()

template<class Model, class Point, class BaseRNG>

void stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::update_gradients ( Point &  z, interface_callbacks::writer::base_writer &  info_writer, interface_callbacks::writer::base_writer &  error_writer  )

inline

Definition at line 104 of file base_hamiltonian.hpp.

update_metric()

template<class Model, class Point, class BaseRNG>

void stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::update_metric ( Point &  z, interface_callbacks::writer::base_writer &  info_writer, interface_callbacks::writer::base_writer &  error_writer  )

inline

Definition at line 94 of file base_hamiltonian.hpp.

update_metric_gradient()

template<class Model, class Point, class BaseRNG>

void stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::update_metric_gradient ( Point &  z, interface_callbacks::writer::base_writer &  info_writer, interface_callbacks::writer::base_writer &  error_writer  )

inline

Definition at line 99 of file base_hamiltonian.hpp.

update_potential()

template<class Model, class Point, class BaseRNG>

void stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::update_potential ( Point &  z, interface_callbacks::writer::base_writer &  info_writer, interface_callbacks::writer::base_writer &  error_writer  )

inline

Definition at line 68 of file base_hamiltonian.hpp.

update_potential_gradient()

template<class Model, class Point, class BaseRNG>

void stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::update_potential_gradient ( Point &  z, interface_callbacks::writer::base_writer &  info_writer, interface_callbacks::writer::base_writer &  error_writer  )

inline

Definition at line 80 of file base_hamiltonian.hpp.

V()

template<class Model, class Point, class BaseRNG>

double stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::V ( Point &  z )

inline

Definition at line 28 of file base_hamiltonian.hpp.

write_error_msg_()

template<class Model, class Point, class BaseRNG>

void stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::write_error_msg_ ( const std::exception &  e, interface_callbacks::writer::base_writer &  writer  )

inlineprotected

Definition at line 114 of file base_hamiltonian.hpp.

Member Data Documentation

model_

template<class Model, class Point, class BaseRNG>

const Model& stan::mcmc::base_hamiltonian< Model, Point, BaseRNG >::model_

protected

Definition at line 112 of file base_hamiltonian.hpp.

---

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

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