Apical_structure_position_move Class Reference

#include <alternaria_moves.h>

Inheritance diagram for Apical_structure_position_move:

Collaboration diagram for Apical_structure_position_move:

List of all members.

Public Member Functions
	Apical_structure_position_move (const char *name, double prob=1.0) throw (jwscxx::base::Arg_error)
	Constructs a Apical_structure_position_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 opacity 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 opacity from the most recent run of this move.

---

Detailed Description

MCMC Sampler move that proposes moving a Apical_structure.

Definition at line 599 of file alternaria_moves.h.

---

Constructor & Destructor Documentation

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

Constructs a Apical_structure_position_move.

Definition at line 604 of file alternaria_moves.h.

---

Member Function Documentation

bool Apical_structure_position_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 3169 of file alternaria_moves.cpp.

const std::ostringstream & Apical_structure_position_move::get_info

(

Sampler_move_parameters *

params

)

[virtual]

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

Parameters:

params

Parameters for the move.

Returns:

Information about the Apical_structure::centroid.

Implements Sampler_move.

Definition at line 3240 of file alternaria_moves.cpp.

const std::ostringstream & Apical_structure_position_move::get_proposal_info

(

Sampler_move_parameters *

params

)

[virtual]

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

Parameters:

params

Parameters for the move.

Returns:

Information about the proposed Apical_structure::centroid.

Implements Sampler_move.

Definition at line 3255 of file alternaria_moves.cpp.

---

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

• alternaria_moves.h
• alternaria_moves.cpp