A struct for holding statistical information about samples. More...

Public Member Functions
void	Clear (bool clear_mode=true, bool clear_efficiency=true)
	clear all members. More...

void	Init (unsigned n_par, unsigned n_obs)
	init all members More...

Statistics &	operator+= (const Statistics &rhs)
	addition assignment operator. More...

void	Reset (bool reset_mode=true, bool reset_efficiency=true)
	reset all members More...

void	ResetEfficiencies ()
	reset efficiencies

	Statistics (unsigned n_par=0, unsigned n_obs=0)
	Constructor. More...

void	Update (const ChainState &cs)
	update statistics given a new chain state

Public Attributes
std::vector< std::vector< double > >	covariance
	covariances of all pairs of variables

std::vector< double >	efficiency
	efficiencies for each parameter (NB: not stored for observables)

std::vector< double >	maximum
	maximum value of variables

std::vector< double >	mean
	means of all variables

std::vector< double >	minimum
	minimum value of variables

std::vector< double >	modeobs
	mode of observables

std::vector< double >	modepar
	mode of parameters

unsigned	n_samples
	number of samples used to calculate statistics

unsigned	n_samples_efficiency
	number of samples used to calculate efficiencies

double	probability_at_mode
	mode of probability

double	probability_mean
	mean of probability

double	probability_variance
	variance of probability

std::vector< double >	stderrobs
	sqrt(variance) of all observables

std::vector< double >	stderrpar
	sqrt(variance) of all parameters

std::vector< double >	variance
	variances of all variables

Detailed Description

A struct for holding statistical information about samples.

Definition at line 187 of file BCEngineMCMC.h.

Constructor & Destructor Documentation

BCEngineMCMC::Statistics::Statistics	(	unsigned	n_par = `0`,
		unsigned	n_obs = `0`
	)

Constructor.

Parameters

n_par	number of parameters to calculate statistics for.
n_obs	number of observables to calculate statistics for (sans efficiencies).

Definition at line 3760 of file BCEngineMCMC.cxx.

void BCEngineMCMC::Statistics::Clear	(	bool	clear_mode = `true`,
		bool	clear_efficiency = `true`
	)

clear all members.

Parameters

clear_mode	Flag for clearing information about mode
clear_efficiency	Flag for clearing information about efficiencies

Definition at line 3780 of file BCEngineMCMC.cxx.

void BCEngineMCMC::Statistics::Init	(	unsigned	n_par,
		unsigned	n_obs
	)

init all members

Parameters

n_par	number of parameters
n_obs	number of observables.

Definition at line 3804 of file BCEngineMCMC.cxx.

BCEngineMCMC::Statistics & BCEngineMCMC::Statistics::operator+= ( const Statistics & rhs )

addition assignment operator.

Definition at line 3908 of file BCEngineMCMC.cxx.

void BCEngineMCMC::Statistics::Reset	(	bool	reset_mode = `true`,
		bool	reset_efficiency = `true`
	)

reset all members

Parameters

reset_mode	flag for resetting information about mode.
reset_efficiency	flag for resetting information about efficiencies.

Definition at line 3824 of file BCEngineMCMC.cxx.

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