Sampler_move Class Reference

#include <sampler.h>

Inheritance diagram for Sampler_move:

Collaboration diagram for Sampler_move:

List of all members.

Public Member Functions
virtual	~Sampler_move ()
	Deletes a Sampler_move.
virtual bool	run (Sampler_move_parameters *params)=0 throw (jwscxx::base::Exception)
	Runs this move and either accepts or rejects.
const char *	get_name () const
	Returns the name of this move.
virtual const std::ostringstream &	get_info (Sampler_move_parameters *params)=0
	Returns information about the current state of the most recent run of this move.
virtual const std::ostringstream &	get_proposal_info (Sampler_move_parameters *params)=0
	Returns information about the proposed state of the most recent run of this move.
virtual double	get_prob () const =0
	Returns the probability of this move.
virtual void	set_prob (double prob)=0 throw (jwscxx::base::Arg_error)
	Sets the probability of this move.
Protected Attributes
const char *	name
	Single word name of this move.
std::ostringstream	info
	String stream to write move information to.
std::ostringstream	proposal_info
	String stream to write move proposal information to.

---

Detailed Description

MCMC Sampler move.

Definition at line 136 of file sampler.h.

---

Constructor & Destructor Documentation

virtual Sampler_move::~Sampler_move

(

)

[inline, virtual]

Deletes a Sampler_move.

Definition at line 141 of file sampler.h.

---

Member Function Documentation

virtual bool Sampler_move::run

(

Sampler_move_parameters *

params

)

throw (jwscxx::base::Exception) [pure virtual]

Runs this move and either accepts or rejects.

Implemented in Sampler_jump_move, Imaging_bg_move, PSF_move, PSF_alpha_move, PSF_beta_move, PSF_gamma_move, Structure_resize_move, Structure_rotate_move, Structure_opacity_move, Apical_structure_position_move, and Lateral_structure_lat_dist_move.

const char* Sampler_move::get_name

(

)

const [inline]

Returns the name of this move.

Definition at line 150 of file sampler.h.

virtual const std::ostringstream& Sampler_move::get_info

(

Sampler_move_parameters *

params

)

[pure virtual]

Returns information about the current state of the most recent run of this move.

Implemented in Sampler_jump_move, Imaging_bg_move, PSF_move, PSF_alpha_move, PSF_beta_move, PSF_gamma_move, Structure_resize_move, Structure_rotate_move, Structure_opacity_move, Apical_structure_position_move, and Lateral_structure_lat_dist_move.

virtual const std::ostringstream& Sampler_move::get_proposal_info

(

Sampler_move_parameters *

params

)

[pure virtual]

Returns information about the proposed state of the most recent run of this move.

Implemented in Sampler_jump_move, Imaging_bg_move, PSF_move, PSF_alpha_move, PSF_beta_move, PSF_gamma_move, Structure_resize_move, Structure_rotate_move, Structure_opacity_move, Apical_structure_position_move, and Lateral_structure_lat_dist_move.

virtual double Sampler_move::get_prob

(

)

const [pure virtual]

Returns the probability of this move.

Implemented in Sampler_diffusion_move, and Sampler_jump_move.

virtual void Sampler_move::set_prob

(

double

prob

)

throw (jwscxx::base::Arg_error) [pure virtual]

Sets the probability of this move.

Implemented in Sampler_diffusion_move, and Sampler_jump_move.

---

Member Data Documentation

const char* Sampler_move::name [protected]

Single word name of this move.

Definition at line 184 of file sampler.h.

std::ostringstream Sampler_move::info [protected]

String stream to write move information to.

Definition at line 187 of file sampler.h.

std::ostringstream Sampler_move::proposal_info [protected]

String stream to write move proposal information to.

Definition at line 190 of file sampler.h.

---

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

• sampler.h