hops::MarkovChainInterface< StateType > Class Template Reference

#include <MarkovChain.hpp>

Inheritance diagram for hops::MarkovChainInterface< StateType >:

Collaboration diagram for hops::MarkovChainInterface< StateType >:

Public Member Functions
virtual	~MarkovChainInterface ()=default
virtual void	draw (RandomNumberGenerator &randomNumberGenerator, long numberOfSamples)=0
	Updates internal state of the chain and stores numberOfSamples samples in memory. More...
virtual void	draw (RandomNumberGenerator &randomNumberGenerator, long numberOfSamples, long thinning)=0
	Updates internal state of the chain and stores numberOfSamples samples in memory. More...
virtual void	writeHistory (FileWriter *fileWriter)=0
	Writes all stored chain history using the fileWriter. More...
virtual void	installDataObject (ChainData &chainData)=0
virtual const std::vector< StateType > &	getStateRecords ()=0
virtual void	reserveStateRecords (long numberOfSamples)=0
virtual void	clearHistory ()=0
	Deletes all stored chain history. More...
virtual std::string	getName ()=0
virtual void	setAttribute (MarkovChainAttribute markovChainAttribute, double value)=0
virtual void	setState (StateType state)=0
virtual double	getAttribute (MarkovChainAttribute markovChainAttribute)=0
virtual double	getAcceptanceRate ()=0

Constructor & Destructor Documentation

~MarkovChainInterface()

template<typename StateType = Eigen::VectorXd>

virtual hops::MarkovChainInterface< StateType >::~MarkovChainInterface ( )

virtualdefault

Member Function Documentation

clearHistory()

template<typename StateType = Eigen::VectorXd>

virtual void hops::MarkovChainInterface< StateType >::clearHistory ( )

pure virtual

Deletes all stored chain history.

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

draw() [1/2]

template<typename StateType = Eigen::VectorXd>

virtual void hops::MarkovChainInterface< StateType >::draw ( RandomNumberGenerator &  randomNumberGenerator, long  numberOfSamples  )

pure virtual

Updates internal state of the chain and stores numberOfSamples samples in memory.

Parameters

randomNumberGenerator
numberOfSamples	Number of samples to draw.

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

draw() [2/2]

template<typename StateType = Eigen::VectorXd>

virtual void hops::MarkovChainInterface< StateType >::draw ( RandomNumberGenerator &  randomNumberGenerator, long  numberOfSamples, long  thinning  )

pure virtual

Updates internal state of the chain and stores numberOfSamples samples in memory.

Parameters

randomNumberGenerator
numberOfSamples	Number of samples to draw.
thinning	Number of internal state updates between every state that is stored.

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

getAcceptanceRate()

template<typename StateType = Eigen::VectorXd>

virtual double hops::MarkovChainInterface< StateType >::getAcceptanceRate ( )

pure virtual

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

getAttribute()

template<typename StateType = Eigen::VectorXd>

virtual double hops::MarkovChainInterface< StateType >::getAttribute ( MarkovChainAttribute  markovChainAttribute )

pure virtual

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

getName()

template<typename StateType = Eigen::VectorXd>

virtual std::string hops::MarkovChainInterface< StateType >::getName ( )

pure virtual

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

getStateRecords()

template<typename StateType = Eigen::VectorXd>

virtual const std::vector<StateType>& hops::MarkovChainInterface< StateType >::getStateRecords ( )

pure virtual

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

installDataObject()

template<typename StateType = Eigen::VectorXd>

virtual void hops::MarkovChainInterface< StateType >::installDataObject ( ChainData &  chainData )

pure virtual

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

reserveStateRecords()

template<typename StateType = Eigen::VectorXd>

virtual void hops::MarkovChainInterface< StateType >::reserveStateRecords ( long  numberOfSamples )

pure virtual

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

setAttribute()

template<typename StateType = Eigen::VectorXd>

virtual void hops::MarkovChainInterface< StateType >::setAttribute ( MarkovChainAttribute  markovChainAttribute, double  value  )

pure virtual

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

setState()

template<typename StateType = Eigen::VectorXd>

virtual void hops::MarkovChainInterface< StateType >::setState ( StateType  state )

pure virtual

writeHistory()

template<typename StateType = Eigen::VectorXd>

virtual void hops::MarkovChainInterface< StateType >::writeHistory ( FileWriter *  fileWriter )

pure virtual

Writes all stored chain history using the fileWriter.

Parameters

fileWriter

Implemented in hops::MarkovChainAdapter< MarkovChainImpl >.

---

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

• MarkovChain.hpp