ParameterBase Class Reference

Pure virtual class provide interface for Parameter. More...

#include <MCMC.h>

Inheritance diagram for ParameterBase:

[legend]List of all members.

Public Member Functions
	ParameterBase (std::string label)
virtual	~ParameterBase (void)
virtual void	Adapt (const double accept)
void	Assign (const boost::any &value)
std::string	Label (void) const
void	SetLabel (const std::string &label)
const boost::any	Value (void) const

---

Detailed Description

Pure virtual class provide interface for Parameter.

Definition at line 84 of file MCMC.h.

---

Constructor & Destructor Documentation

ParameterBase::ParameterBase

(

std::string

label

)

Constructor

Parameters:

label

a string identifier for the parameter

Used internally to construct Parameter classes. Not intended for direct use.

Definition at line 309 of file MCMC.cpp.

ParameterBase::~ParameterBase

(

void

)

[virtual]

Destructor

Definition at line 315 of file MCMC.cpp.

---

Member Function Documentation

void ParameterBase::Adapt

(

const double

accept

)

[virtual]

Adapt the proposal distribution in a Metropolis-Hastings sampler

Parameters:

accept

the current acceptance percentage

Definition at line 323 of file MCMC.cpp.

void ParameterBase::Assign

(

const boost::any &

value

)

sets value of the parameter

Parameters:

value

the value to be assigned

Definition at line 351 of file MCMC.cpp.

std::string ParameterBase::Label

(

void

)

const

Returns string identifying current parameter

The default value is an empty string. Replace it by including an argument to the constructor

Definition at line 376 of file MCMC.cpp.

Referenced by StepBase::Label().

void ParameterBase::SetLabel

(

const std::string &

label

)

Set the label associated with this parameter

Parameters:

label

the label string

Definition at line 385 of file MCMC.cpp.

Referenced by StepBase::SetLabel().

const boost::any ParameterBase::Value

(

void

)

const

Value of the parameter

Reimplemented in ParameterT< T >, and ParameterT< double >.

Definition at line 413 of file MCMC.cpp.

Referenced by StepBase::aValue().

---

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

• MCMC.h
• MCMC.cpp

---