subpavings::MCMCGRDiagnosticIntervalLeaves Class Reference

Inheritance diagram for subpavings::MCMCGRDiagnosticIntervalLeaves:

Collaboration diagram for subpavings::MCMCGRDiagnosticIntervalLeaves:

List of all members.

Public Member Functions
	MCMCGRDiagnosticIntervalLeaves (cxsc::real t, size_t si, double percent, bool req=false)
	Constructor.
	MCMCGRDiagnosticIntervalLeaves (cxsc::real t, size_t si, size_t sm, double percent, bool req=false)
	Constructor.
std::string	getGRWorkingCalcsFilename () const
	Get the name used by this in output files for working calculations.
std::string	getGRDiagnosticsFilename () const
	Get the name used by this in results files.
std::string	getScalarsName () const
	Get the name used by this for the scalar type it is using.

---

Constructor & Destructor Documentation

MCMCGRDiagnosticIntervalLeaves::MCMCGRDiagnosticIntervalLeaves	(	cxsc::real	t,
		size_t	si,
		double	percent,
		bool	req = false
	)

Constructor.

The largest number of states used for the calculation of each within chain interval will be 1,000,000 or the next integer multiple of above that figure.

Parameters:

t	The tolerance to use for the Gelman-Rubin convergence criteria.
si	the size of the sampling interval to use for recalculating the diagnostic, eg si = 1 will recalculate for every change of state, si = 1000 will recalculate every 1000 changes of state, etc.
percent	the percentage interval to calculate.
req	flag for whether this diagnostic must be satisfied for burn-in. Defaults to false (this does not have to be satisfied).

Precondition:

t > 0.0, 0.0 < percent < 1.0.

  : MCMCGRDiagnosticInterval(t, si, percent, req)
{}

MCMCGRDiagnosticIntervalLeaves::MCMCGRDiagnosticIntervalLeaves	(	cxsc::real	t,
		size_t	si,
		size_t	sm,
		double	percent,
		bool	req = false
	)

Constructor.

Parameters:

t	The tolerance to use for the Gelman-Rubin convergence criteria.
si	the size of the sampling interval to use for recalculating the diagnostic, eg si = 1 will recalculate for every change of state, si = 1000 will recalculate every 1000 changes of state, etc.
sm	the maximum number of states to be used for any one within-chain interval. If this is not an integer multiple of si then the maximum number of states used in the calculations will be sm rounded up to the next integer multiple of si greater than sm.
percent	the percentage interval to calculate.
req	flag for whether this diagnostic must be satisfied for burn-in.

Precondition:

t > 0.0, 0.0 < percent < 1.0.

  : MCMCGRDiagnosticInterval(t, si, sm, percent, req)
{}

---

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

• MCMCGRDiagnosticIntervalLeaves.hpp
• MCMCGRDiagnosticIntervalLeaves.cpp