Lateral_structure_lat_dist_move Class Reference

#include <alternaria_moves.h>

Inheritance diagram for Lateral_structure_lat_dist_move:

Collaboration diagram for Lateral_structure_lat_dist_move:

List of all members.

Public Member Functions
	Lateral_structure_lat_dist_move (const char *name, double prob=1.0) throw (jwscxx::base::Arg_error)
	Constructs an Lateral_structure_lat_dist_move.
bool	run (Sampler_move_parameters *params) throw (jwscxx::base::Exception)
	Runs this move and either accepts or rejects.
const std::ostringstream &	get_info (Sampler_move_parameters *params)
	Returns information about the current state of the Structure lateral distance from the most recent run of this move.
const std::ostringstream &	get_proposal_info (Sampler_move_parameters *params)
	Returns information about the state of the proposed Structure lateral distance from the most recent run of this move.

---

Detailed Description

MCMC Sampler move that proposes changing the opacity of a random Lateral_structure.

Definition at line 638 of file alternaria_moves.h.

---

Constructor & Destructor Documentation

Lateral_structure_lat_dist_move::Lateral_structure_lat_dist_move	(	const char *	name,
		double	prob = 1.0
	)		throw (jwscxx::base::Arg_error) [inline]

Constructs an Lateral_structure_lat_dist_move.

Definition at line 643 of file alternaria_moves.h.

---

Member Function Documentation

bool Lateral_structure_lat_dist_move::run

(

Sampler_move_parameters *

params

)

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

Runs this move and either accepts or rejects.

Parameters:

params

Parameters for the move.

Returns:

If the proposal is accepted, 1; otherwise 0.

Implements Sampler_move.

Definition at line 3269 of file alternaria_moves.cpp.

const std::ostringstream & Lateral_structure_lat_dist_move::get_info

(

Sampler_move_parameters *

params

)

[virtual]

Returns information about the current state of the Structure lateral distance from the most recent run of this move.

Parameters:

params

Parameters for the move.

Returns:

Information about the Lateral_structure::lat_dist.

Implements Sampler_move.

Definition at line 3417 of file alternaria_moves.cpp.

const std::ostringstream & Lateral_structure_lat_dist_move::get_proposal_info

(

Sampler_move_parameters *

params

)

[virtual]

Returns information about the state of the proposed Structure lateral distance from the most recent run of this move.

Parameters:

params

Parameters for the move.

Returns:

Information about the proposed Lateral_structure::lat_dist.

Implements Sampler_move.

Definition at line 3432 of file alternaria_moves.cpp.

---

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

• alternaria_moves.h
• alternaria_moves.cpp