A struct that represents a Metropolis-Hastings sample. More...

#include <MetropolisHastingsSG.h>

Public Member Functions
Constructor/Destructor methods
	MHRawChainInfoStruct ()
	Constructor. More...

	MHRawChainInfoStruct (const MHRawChainInfoStruct &rhs)
	Copy constructor. More...

	~MHRawChainInfoStruct ()
	Destructor. More...

Set methods
MHRawChainInfoStruct &	operator= (const MHRawChainInfoStruct &rhs)
	Assignment operator. More...

MHRawChainInfoStruct &	operator+= (const MHRawChainInfoStruct &rhs)
	Addition assignment operator. More...

Misc methods
void	copy (const MHRawChainInfoStruct &src)
	Copies Metropolis-Hastings chain info from `src` to `this`. More...

void	reset ()
	Resets Metropolis-Hastings chain info. More...

void	mpiSum (const MpiComm &comm, MHRawChainInfoStruct &sumInfo)
	Calculates the MPI sum of `this`. More...

Public Attributes
double	runTime

double	candidateRunTime

double	targetRunTime

double	mhAlphaRunTime

double	drAlphaRunTime

double	drRunTime

double	amRunTime

unsigned int	numTargetCalls

unsigned int	numDRs

unsigned int	numOutOfTargetSupport

unsigned int	numOutOfTargetSupportInDR

unsigned int	numRejections

Detailed Description

A struct that represents a Metropolis-Hastings sample.

Some of the information about the Metropolis-Hastings sample generator includes the allowed number of delayed rejections, number of rejections, number of positions in or out of target support, and so on. This struct is responsible for the storage of such info.

Definition at line 61 of file MetropolisHastingsSG.h.

Constructor & Destructor Documentation

QUESO::MHRawChainInfoStruct::MHRawChainInfoStruct ( )

Constructor.

Definition at line 46 of file MetropolisHastingsSG.C.

References reset().

 {
   reset();
 }

QUESO::MHRawChainInfoStruct::MHRawChainInfoStruct ( const MHRawChainInfoStruct & rhs )

Copy constructor.

Definition at line 51 of file MetropolisHastingsSG.C.

References copy().

 {
   this->copy(rhs);
 }

QUESO::MHRawChainInfoStruct::~MHRawChainInfoStruct ( )

Destructor.

Definition at line 56 of file MetropolisHastingsSG.C.

57 {

58 }

Member Function Documentation

void QUESO::MHRawChainInfoStruct::copy ( const MHRawChainInfoStruct & src )

Copies Metropolis-Hastings chain info from src to this.

Definition at line 106 of file MetropolisHastingsSG.C.

References amRunTime, candidateRunTime, drAlphaRunTime, drRunTime, mhAlphaRunTime, numDRs, numOutOfTargetSupport, numOutOfTargetSupportInDR, numRejections, numTargetCalls, runTime, and targetRunTime.

Referenced by MHRawChainInfoStruct(), and operator=().

 {
   runTime          = rhs.runTime;
   candidateRunTime = rhs.candidateRunTime;
   targetRunTime    = rhs.targetRunTime;
   mhAlphaRunTime   = rhs.mhAlphaRunTime;
   drAlphaRunTime   = rhs.drAlphaRunTime;
   drRunTime        = rhs.drRunTime;
   amRunTime        = rhs.amRunTime;
 
   numTargetCalls            = rhs.numTargetCalls;
   numDRs                    = rhs.numDRs;
   numOutOfTargetSupport     = rhs.numOutOfTargetSupport;
   numOutOfTargetSupportInDR = rhs.numOutOfTargetSupportInDR;
   numRejections             = rhs.numRejections;
 
   return;
 }

void QUESO::MHRawChainInfoStruct::mpiSum	(	const MpiComm &	comm,
		MHRawChainInfoStruct &	sumInfo
	)

Calculates the MPI sum of this.

Definition at line 126 of file MetropolisHastingsSG.C.

References QUESO::MpiComm::Allreduce(), numTargetCalls, and runTime.

 {
   comm.Allreduce<double>(&runTime, &sumInfo.runTime, (int) 7, RawValue_MPI_SUM,
                  "MHRawChainInfoStruct::mpiSum()",
                  "failed MPI.Allreduce() for sum of doubles");
 
   comm.Allreduce<unsigned int>(&numTargetCalls, &sumInfo.numTargetCalls, (int) 5, RawValue_MPI_SUM,
                  "MHRawChainInfoStruct::mpiSum()",
                  "failed MPI.Allreduce() for sum of unsigned ints");
 
   return;
 }

MHRawChainInfoStruct & QUESO::MHRawChainInfoStruct::operator+= ( const MHRawChainInfoStruct & rhs )

Addition assignment operator.

Definition at line 68 of file MetropolisHastingsSG.C.

References amRunTime, candidateRunTime, drAlphaRunTime, drRunTime, mhAlphaRunTime, numDRs, numOutOfTargetSupport, numOutOfTargetSupportInDR, numRejections, numTargetCalls, runTime, and targetRunTime.

 {
   runTime          += rhs.runTime;
   candidateRunTime += rhs.candidateRunTime;
   targetRunTime    += rhs.targetRunTime;
   mhAlphaRunTime   += rhs.mhAlphaRunTime;
   drAlphaRunTime   += rhs.drAlphaRunTime;
   drRunTime        += rhs.drRunTime;
   amRunTime        += rhs.amRunTime;
 
   numTargetCalls            += rhs.numTargetCalls;
   numDRs                    += rhs.numDRs;
   numOutOfTargetSupport     += rhs.numOutOfTargetSupport;
   numOutOfTargetSupportInDR += rhs.numOutOfTargetSupportInDR;
   numRejections             += rhs.numRejections;
 
   return *this;
 }

MHRawChainInfoStruct & QUESO::MHRawChainInfoStruct::operator= ( const MHRawChainInfoStruct & rhs )

Assignment operator.

Definition at line 61 of file MetropolisHastingsSG.C.

References copy().

 {
   this->copy(rhs);
   return *this;
 }

void QUESO::MHRawChainInfoStruct::reset ( )

Resets Metropolis-Hastings chain info.

Definition at line 88 of file MetropolisHastingsSG.C.

References amRunTime, candidateRunTime, drAlphaRunTime, drRunTime, mhAlphaRunTime, numDRs, numOutOfTargetSupport, numOutOfTargetSupportInDR, numRejections, numTargetCalls, runTime, and targetRunTime.

Referenced by MHRawChainInfoStruct().

 {
   runTime          = 0.;
   candidateRunTime = 0.;
   targetRunTime    = 0.;
   mhAlphaRunTime   = 0.;
   drAlphaRunTime   = 0.;
   drRunTime        = 0.;
   amRunTime        = 0.;
 
   numTargetCalls            = 0;
   numDRs                    = 0;
   numOutOfTargetSupport     = 0;
   numOutOfTargetSupportInDR = 0;
   numRejections             = 0;
 }