versatile-mcmc  0.1.7
Public Member Functions | Protected Attributes | List of all members
vmcmc::ProposalDistribution< DistributionT > Class Template Reference

Abstract proposal function class, which randomly draws from a multivariate random distribution centered at current sample / parameter vector. More...

#include <proposal.hpp>

Inheritance diagram for vmcmc::ProposalDistribution< DistributionT >:
Inheritance graph
[legend]
Collaboration diagram for vmcmc::ProposalDistribution< DistributionT >:
Collaboration graph
[legend]

Public Member Functions

 ProposalDistribution (DistributionT &&dist=DistributionT())
 
double Transition (const Vector &s1, Vector &s2) override
 Propose a new state. More...
 
void UpdateParameterConfig (const ParameterConfig &paramConfig) override
 
const MatrixLower & GetCholeskyDecomp () const
 
- Public Member Functions inherited from vmcmc::Proposal
virtual ProposalClone () const =0
 
double Transition (const Sample &s1, Sample &s2)
 

Protected Attributes

DistributionT fDistribution
 
MatrixLower fCholeskyDecomp
 

Detailed Description

template<typename DistributionT>
class vmcmc::ProposalDistribution< DistributionT >

Abstract proposal function class, which randomly draws from a multivariate random distribution centered at current sample / parameter vector.

If the full covariance matrix of the parameter configuration is provided, correlations are taken into account when setting up the random distribution.

Member Function Documentation

template<typename DistributionT >
double vmcmc::ProposalDistribution< DistributionT >::Transition ( const Vector &  s1,
Vector &  s2 
)
overridevirtual

Propose a new state.

Parameters
[in]s1The original state to start from.
[out]s2The new proposed state.
Returns
The asymmetry ratio. (1.0 for symmetric proposal functions).

Implements vmcmc::Proposal.


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