KJB
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Mh_proposal_result Struct Reference

Indicates the result of an MH proposal. It is simply a pair of probabilities, forward and backward. More...

#include <sample_base.h>

Public Member Functions

 Mh_proposal_result (const std::string &type_=std::string(""))
 
 Mh_proposal_result (double fp, double rp, const std::string &type_=std::string(""))
 
bool operator== (const Mh_proposal_result &pr)
 
bool operator!= (const Mh_proposal_result &pr)
 
Mh_proposal_resultoperator+= (const Mh_proposal_result &pr)
 

Static Public Member Functions

static Mh_proposal_result unchanged (const std::string &type_=std::string(""))
 named constructor - returns a proposal result indicating the model was not changed More...
 

Public Attributes

double fwd_prob
 log forward proposal probability More...
 
double rev_prob
 log reverse proposal probability More...
 
std::string type
 Name of proposal type. More...
 
bool no_change
 proposal didn't modify the model More...
 

Detailed Description

Indicates the result of an MH proposal. It is simply a pair of probabilities, forward and backward.

Constructor & Destructor Documentation

Mh_proposal_result::Mh_proposal_result ( const std::string &  type_ = std::string(""))
inline
Mh_proposal_result::Mh_proposal_result ( double  fp,
double  rp,
const std::string &  type_ = std::string("") 
)
inline
Parameters
fplog forward proposal probability
rplog reverse proposal probability
type_optional description of proposal (no spaces)

Member Function Documentation

bool Mh_proposal_result::operator!= ( const Mh_proposal_result pr)
inline
Mh_proposal_result& Mh_proposal_result::operator+= ( const Mh_proposal_result pr)
inline
bool Mh_proposal_result::operator== ( const Mh_proposal_result pr)
inline
static Mh_proposal_result Mh_proposal_result::unchanged ( const std::string &  type_ = std::string(""))
inlinestatic

named constructor - returns a proposal result indicating the model was not changed

Member Data Documentation

double Mh_proposal_result::fwd_prob

log forward proposal probability

bool Mh_proposal_result::no_change

proposal didn't modify the model

double Mh_proposal_result::rev_prob

log reverse proposal probability

std::string Mh_proposal_result::type

Name of proposal type.


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