A templated class that stores default statistical options for a sequence of vectors, e.g. a Markov chain, a Monte Carlo input sequence, or a Monte Carlo output sequence. More...

#include <SequenceStatisticalOptions.h>

Public Member Functions
Constructor/Destructor methods
	SsOptionsValues ()
	Default constructor. More...

	SsOptionsValues (const BaseEnvironment env, const char prefix)
	Prefix constructor. More...

	SsOptionsValues (const SsOptionsValues &src)
	Copy constructor. More...

virtual	~SsOptionsValues ()
	Destructor. More...

Set methods
SsOptionsValues &	operator= (const SsOptionsValues &rhs)
	Assignment operator; it copies `rhs` to `this`. More...

Public Attributes
Public attributes
std::string	m_prefix

std::vector< double >	m_initialDiscardedPortions
	Stores the initial discarded portion of the chain. More...

bool	m_autoCorrComputeViaDef
	Whether or not compute autocorrelation via definition. More...

bool	m_autoCorrComputeViaFft
	Whether or not compute autocorrelation via FFT. More...

unsigned int	m_autoCorrSecondLag
	Second lag of the autocorrelation. More...

unsigned int	m_autoCorrLagSpacing
	Lag spacing of the autocorrelation. More...

unsigned int	m_autoCorrNumLags
	Number of lags of the autocorrelation. More...

bool	m_autoCorrDisplay
	Whether or not display autocorrelation. More...

bool	m_autoCorrWrite
	Whether or not write autocorrelation to file. More...

bool	m_kdeCompute
	Whether or not compute kernel density estimate (kde). More...

unsigned int	m_kdeNumEvalPositions
	Number of positions to evaluate kde. More...

bool	m_covMatrixCompute
	Whether or not compute covariance matrix. More...

bool	m_corrMatrixCompute
	Whether or not compute correlation matrix. More...

unsigned int	m_meanMonitorPeriod

bool	m_bmmRun

std::vector< unsigned int >	m_bmmLengths

bool	m_bmmDisplay

bool	m_bmmWrite

bool	m_fftCompute

unsigned int	m_fftParamId

unsigned int	m_fftSize

bool	m_fftTestInversion

bool	m_fftWrite

bool	m_psdCompute

unsigned int	m_psdNumBlocks

double	m_psdHopSizeRatio

unsigned int	m_psdParamId

bool	m_psdWrite

bool	m_psdAtZeroCompute

std::vector< unsigned int >	m_psdAtZeroNumBlocks

double	m_psdAtZeroHopSizeRatio

bool	m_psdAtZeroDisplay

bool	m_psdAtZeroWrite

bool	m_gewekeCompute

double	m_gewekeNaRatio

double	m_gewekeNbRatio

bool	m_gewekeDisplay

bool	m_gewekeWrite

bool	m_meanStaccCompute

bool	m_histCompute

unsigned int	m_histNumInternalBins

bool	m_cdfStaccCompute

unsigned int	m_cdfStaccNumEvalPositions

Private Member Functions
void	copy (const SsOptionsValues &src)
	Copies the option values from `src` to `this`. More...

Private Attributes
BoostInputOptionsParser *	m_parser

std::string	m_option_help

std::string	m_option_initialDiscardedPortions

std::string	m_option_autoCorr_computeViaDef

std::string	m_option_autoCorr_computeViaFft

std::string	m_option_autoCorr_secondLag

std::string	m_option_autoCorr_lagSpacing

std::string	m_option_autoCorr_numLags

std::string	m_option_autoCorr_display

std::string	m_option_autoCorr_write

std::string	m_option_kde_compute

std::string	m_option_kde_numEvalPositions

std::string	m_option_covMatrix_compute

std::string	m_option_corrMatrix_compute

std::string	m_option_mean_monitorPeriod

std::string	m_option_bmm_run

std::string	m_option_bmm_lengths

std::string	m_option_bmm_display

std::string	m_option_bmm_write

std::string	m_option_fft_compute

std::string	m_option_fft_paramId

std::string	m_option_fft_size

std::string	m_option_fft_testInversion

std::string	m_option_fft_write

std::string	m_option_psd_compute

std::string	m_option_psd_numBlocks

std::string	m_option_psd_hopSizeRatio

std::string	m_option_psd_paramId

std::string	m_option_psd_write

std::string	m_option_psdAtZero_compute

std::string	m_option_psdAtZero_numBlocks

std::string	m_option_psdAtZero_hopSizeRatio

std::string	m_option_psdAtZero_display

std::string	m_option_psdAtZero_write

std::string	m_option_geweke_compute

std::string	m_option_geweke_naRatio

std::string	m_option_geweke_nbRatio

std::string	m_option_geweke_display

std::string	m_option_geweke_write

std::string	m_option_meanStacc_compute

std::string	m_option_hist_compute

std::string	m_option_hist_numInternalBins

std::string	m_option_cdfStacc_compute

std::string	m_option_cdfStacc_numEvalPositions

Detailed Description

A templated class that stores default statistical options for a sequence of vectors, e.g. a Markov chain, a Monte Carlo input sequence, or a Monte Carlo output sequence.

Definition at line 94 of file SequenceStatisticalOptions.h.

Constructor & Destructor Documentation

SsOptionsValues::SsOptionsValues ( )

Default constructor.

It assigns to the variables the pre-defined options for a sequence of data (scalars; vectors).

Definition at line 37 of file SequenceStatisticalOptions.C.

   :
     m_prefix                          ("stats_"),
     m_initialDiscardedPortions(0                                           ),//,0.),
 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
     m_meanMonitorPeriod       (UQ_SEQUENCE_MEAN_MONITOR_PERIOD_ODV         ),
     m_bmmRun                  (UQ_SEQUENCE_BMM_RUN_ODV                     ),
     m_bmmLengths              (0                                           ),//,0),
     m_fftCompute              (UQ_SEQUENCE_FFT_COMPUTE_ODV                 ),
     m_fftParamId              (UQ_SEQUENCE_FFT_PARAM_ID_ODV                ),
     m_fftSize                 (UQ_SEQUENCE_FFT_SIZE_ODV                    ),
     m_fftTestInversion        (UQ_SEQUENCE_FFT_TEST_INVERSION_ODV          ),
     m_fftWrite                (UQ_SEQUENCE_FFT_WRITE_ODV                   ),
     m_psdCompute              (UQ_SEQUENCE_PSD_COMPUTE_ODV                 ),
     m_psdNumBlocks            (UQ_SEQUENCE_PSD_NUM_BLOCKS_ODV              ),
     m_psdHopSizeRatio         (UQ_SEQUENCE_PSD_HOP_SIZE_RATIO_ODV          ),
     m_psdParamId              (UQ_SEQUENCE_PSD_PARAM_ID_ODV                ),
     m_psdWrite                (UQ_SEQUENCE_PSD_WRITE_ODV                   ),
     m_psdAtZeroCompute        (UQ_SEQUENCE_PSD_AT_ZERO_COMPUTE_ODV         ),
     m_psdAtZeroNumBlocks      (0                                           ),//,0),
     m_psdAtZeroHopSizeRatio   (UQ_SEQUENCE_PSD_AT_ZERO_HOP_SIZE_RATIO_ODV  ),
     m_psdAtZeroDisplay        (UQ_SEQUENCE_PSD_AT_ZERO_DISPLAY_ODV         ),
     m_psdAtZeroWrite          (UQ_SEQUENCE_PSD_AT_ZERO_WRITE_ODV           ),
     m_gewekeCompute           (UQ_SEQUENCE_GEWEKE_COMPUTE_ODV              ),
     m_gewekeNaRatio           (UQ_SEQUENCE_GEWEKE_NA_RATIO_ODV             ),
     m_gewekeNbRatio           (UQ_SEQUENCE_GEWEKE_NB_RATIO_ODV             ),
     m_gewekeDisplay           (UQ_SEQUENCE_GEWEKE_DISPLAY_ODV              ),
     m_gewekeWrite             (UQ_SEQUENCE_GEWEKE_WRITE_ODV                ),
     m_meanStaccCompute        (UQ_SEQUENCE_MEAN_STACC_COMPUTE_ODV          ),
     m_histCompute             (UQ_SEQUENCE_HIST_COMPUTE_ODV                ),
     m_histNumInternalBins     (UQ_SEQUENCE_HIST_NUM_INTERNAL_BINS_ODV      ),
     m_cdfStaccCompute         (UQ_SEQUENCE_CDF_STACC_COMPUTE_ODV           ),
     m_cdfStaccNumEvalPositions(UQ_SEQUENCE_CDF_STACC_NUM_EVAL_POSITIONS_ODV),
 #endif
     m_autoCorrComputeViaDef   (UQ_SEQUENCE_AUTO_CORR_COMPUTE_VIA_DEF_ODV   ),
     m_autoCorrComputeViaFft   (UQ_SEQUENCE_AUTO_CORR_COMPUTE_VIA_FFT_ODV   ),
     m_autoCorrSecondLag       (UQ_SEQUENCE_AUTO_CORR_SECOND_LAG_ODV        ),
     m_autoCorrLagSpacing      (UQ_SEQUENCE_AUTO_CORR_LAG_SPACING_ODV       ),
     m_autoCorrNumLags         (UQ_SEQUENCE_AUTO_CORR_NUM_LAGS_ODV          ),
     m_autoCorrDisplay         (UQ_SEQUENCE_AUTO_CORR_DISPLAY_ODV           ),
     m_autoCorrWrite           (UQ_SEQUENCE_AUTO_CORR_WRITE_ODV             ),
     m_kdeCompute              (UQ_SEQUENCE_KDE_COMPUTE_ODV                 ),
     m_kdeNumEvalPositions     (UQ_SEQUENCE_KDE_NUM_EVAL_POSITIONS_ODV      ),
     m_covMatrixCompute        (UQ_SEQUENCE_COV_MATRIX_COMPUTE_ODV          ),
     m_corrMatrixCompute       (UQ_SEQUENCE_CORR_MATRIX_COMPUTE_ODV         ),
     m_option_help                     (m_prefix + "help"                     ),
     m_option_initialDiscardedPortions (m_prefix + "initialDiscardedPortions" ),
 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
     m_option_mean_monitorPeriod       (m_prefix + "mean_monitorPeriod"       ),
     m_option_bmm_run                  (m_prefix + "bmm_run"                  ),
     m_option_bmm_lengths              (m_prefix + "bmm_lengths"              ),
     m_option_bmm_display              (m_prefix + "bmm_display"              ),
     m_option_bmm_write                (m_prefix + "bmm_write"                ),
     m_option_fft_compute              (m_prefix + "fft_compute"              ),
     m_option_fft_paramId              (m_prefix + "fft_paramId"              ),
     m_option_fft_size                 (m_prefix + "fft_size"                 ),
     m_option_fft_testInversion        (m_prefix + "fft_testInversion"        ),
     m_option_fft_write                (m_prefix + "fft_write"                ),
     m_option_psd_compute              (m_prefix + "psd_compute"              ),
     m_option_psd_numBlocks            (m_prefix + "psd_numBlocks"            ),
     m_option_psd_hopSizeRatio         (m_prefix + "psd_hopSizeRatio"         ),
     m_option_psd_paramId              (m_prefix + "psd_paramId"              ),
     m_option_psd_write                (m_prefix + "psd_write"                ),
     m_option_psdAtZero_compute        (m_prefix + "psdAtZero_compute"        ),
     m_option_psdAtZero_numBlocks      (m_prefix + "psdAtZero_numBlocks"      ),
     m_option_psdAtZero_hopSizeRatio   (m_prefix + "psdAtZero_hopSizeRatio"   ),
     m_option_psdAtZero_display        (m_prefix + "psdAtZero_display"        ),
     m_option_psdAtZero_write          (m_prefix + "psdAtZero_write"          ),
     m_option_geweke_compute           (m_prefix + "geweke_compute"           ),
     m_option_geweke_naRatio           (m_prefix + "geweke_naRatio"           ),
     m_option_geweke_nbRatio           (m_prefix + "geweke_nbRatio"           ),
     m_option_geweke_display           (m_prefix + "geweke_display"           ),
     m_option_geweke_write             (m_prefix + "geweke_write"             ),
     m_option_meanStacc_compute        (m_prefix + "meanStacc_compute"        ),
     m_option_hist_compute             (m_prefix + "hist_compute"             ),
     m_option_hist_numInternalBins     (m_prefix + "hist_numInternalBins"     ),
     m_option_cdfStacc_compute         (m_prefix + "cdfStacc_compute"         ),
     m_option_cdfStacc_numEvalPositions(m_prefix + "cdfStacc_numEvalPositions"),
 #endif
     m_option_autoCorr_computeViaDef   (m_prefix + "autoCorr_computeViaDef"   ),
     m_option_autoCorr_computeViaFft   (m_prefix + "autoCorr_computeViaFft"   ),
     m_option_autoCorr_secondLag       (m_prefix + "autoCorr_secondLag"       ),
     m_option_autoCorr_lagSpacing      (m_prefix + "autoCorr_lagSpacing"      ),
     m_option_autoCorr_numLags         (m_prefix + "autoCorr_numLags"         ),
     m_option_autoCorr_display         (m_prefix + "autoCorr_display"         ),
     m_option_autoCorr_write           (m_prefix + "autoCorr_write"           ),
     m_option_kde_compute              (m_prefix + "kde_compute"              ),
     m_option_kde_numEvalPositions     (m_prefix + "kde_numEvalPositions"     ),
     m_option_covMatrix_compute        (m_prefix + "covMatrix_compute"        ),
     m_option_corrMatrix_compute       (m_prefix + "corrMatrix_compute"       )
 {
 }

SsOptionsValues::SsOptionsValues	(	const BaseEnvironment *	env,
		const char *	prefix
	)

Prefix constructor.

Uses the prefix to read options from an input file.

Definition at line 130 of file SequenceStatisticalOptions.C.

References m_option_autoCorr_computeViaDef, m_option_autoCorr_computeViaFft, m_option_autoCorr_display, m_option_autoCorr_lagSpacing, m_option_autoCorr_numLags, m_option_autoCorr_secondLag, m_option_autoCorr_write, m_option_bmm_lengths, m_option_bmm_run, m_option_cdfStacc_compute, m_option_cdfStacc_numEvalPositions, m_option_corrMatrix_compute, m_option_covMatrix_compute, m_option_fft_compute, m_option_fft_paramId, m_option_fft_size, m_option_fft_testInversion, m_option_fft_write, m_option_geweke_compute, m_option_geweke_display, m_option_geweke_naRatio, m_option_geweke_nbRatio, m_option_geweke_write, m_option_help, m_option_hist_compute, m_option_hist_numInternalBins, m_option_initialDiscardedPortions, m_option_kde_compute, m_option_kde_numEvalPositions, m_option_mean_monitorPeriod, m_option_meanStacc_compute, m_option_psd_compute, m_option_psd_hopSizeRatio, m_option_psd_numBlocks, m_option_psd_paramId, m_option_psd_write, m_option_psdAtZero_compute, m_option_psdAtZero_display, m_option_psdAtZero_hopSizeRatio, m_option_psdAtZero_numBlocks, m_option_psdAtZero_write, and m_parser.

   :
     m_prefix                          ((std::string)(prefix) + "stats_"),
     m_initialDiscardedPortions(0                                           ),//,0.),
 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
     m_meanMonitorPeriod       (UQ_SEQUENCE_MEAN_MONITOR_PERIOD_ODV         ),
     m_bmmRun                  (UQ_SEQUENCE_BMM_RUN_ODV                     ),
     m_bmmLengths              (0                                           ),//,0),
     m_fftCompute              (UQ_SEQUENCE_FFT_COMPUTE_ODV                 ),
     m_fftParamId              (UQ_SEQUENCE_FFT_PARAM_ID_ODV                ),
     m_fftSize                 (UQ_SEQUENCE_FFT_SIZE_ODV                    ),
     m_fftTestInversion        (UQ_SEQUENCE_FFT_TEST_INVERSION_ODV          ),
     m_fftWrite                (UQ_SEQUENCE_FFT_WRITE_ODV                   ),
     m_psdCompute              (UQ_SEQUENCE_PSD_COMPUTE_ODV                 ),
     m_psdNumBlocks            (UQ_SEQUENCE_PSD_NUM_BLOCKS_ODV              ),
     m_psdHopSizeRatio         (UQ_SEQUENCE_PSD_HOP_SIZE_RATIO_ODV          ),
     m_psdParamId              (UQ_SEQUENCE_PSD_PARAM_ID_ODV                ),
     m_psdWrite                (UQ_SEQUENCE_PSD_WRITE_ODV                   ),
     m_psdAtZeroCompute        (UQ_SEQUENCE_PSD_AT_ZERO_COMPUTE_ODV         ),
     m_psdAtZeroNumBlocks      (0                                           ),//,0),
     m_psdAtZeroHopSizeRatio   (UQ_SEQUENCE_PSD_AT_ZERO_HOP_SIZE_RATIO_ODV  ),
     m_psdAtZeroDisplay        (UQ_SEQUENCE_PSD_AT_ZERO_DISPLAY_ODV         ),
     m_psdAtZeroWrite          (UQ_SEQUENCE_PSD_AT_ZERO_WRITE_ODV           ),
     m_gewekeCompute           (UQ_SEQUENCE_GEWEKE_COMPUTE_ODV              ),
     m_gewekeNaRatio           (UQ_SEQUENCE_GEWEKE_NA_RATIO_ODV             ),
     m_gewekeNbRatio           (UQ_SEQUENCE_GEWEKE_NB_RATIO_ODV             ),
     m_gewekeDisplay           (UQ_SEQUENCE_GEWEKE_DISPLAY_ODV              ),
     m_gewekeWrite             (UQ_SEQUENCE_GEWEKE_WRITE_ODV                ),
     m_meanStaccCompute        (UQ_SEQUENCE_MEAN_STACC_COMPUTE_ODV          ),
     m_histCompute             (UQ_SEQUENCE_HIST_COMPUTE_ODV                ),
     m_histNumInternalBins     (UQ_SEQUENCE_HIST_NUM_INTERNAL_BINS_ODV      ),
     m_cdfStaccCompute         (UQ_SEQUENCE_CDF_STACC_COMPUTE_ODV           ),
     m_cdfStaccNumEvalPositions(UQ_SEQUENCE_CDF_STACC_NUM_EVAL_POSITIONS_ODV),
 #endif
     m_autoCorrComputeViaDef   (UQ_SEQUENCE_AUTO_CORR_COMPUTE_VIA_DEF_ODV   ),
     m_autoCorrComputeViaFft   (UQ_SEQUENCE_AUTO_CORR_COMPUTE_VIA_FFT_ODV   ),
     m_autoCorrSecondLag       (UQ_SEQUENCE_AUTO_CORR_SECOND_LAG_ODV        ),
     m_autoCorrLagSpacing      (UQ_SEQUENCE_AUTO_CORR_LAG_SPACING_ODV       ),
     m_autoCorrNumLags         (UQ_SEQUENCE_AUTO_CORR_NUM_LAGS_ODV          ),
     m_autoCorrDisplay         (UQ_SEQUENCE_AUTO_CORR_DISPLAY_ODV           ),
     m_autoCorrWrite           (UQ_SEQUENCE_AUTO_CORR_WRITE_ODV             ),
     m_kdeCompute              (UQ_SEQUENCE_KDE_COMPUTE_ODV                 ),
     m_kdeNumEvalPositions     (UQ_SEQUENCE_KDE_NUM_EVAL_POSITIONS_ODV      ),
     m_covMatrixCompute        (UQ_SEQUENCE_COV_MATRIX_COMPUTE_ODV          ),
     m_corrMatrixCompute       (UQ_SEQUENCE_CORR_MATRIX_COMPUTE_ODV         ),
     m_parser(new BoostInputOptionsParser(env->optionsInputFileName())),
     m_option_help                     (m_prefix + "help"                     ),
     m_option_initialDiscardedPortions (m_prefix + "initialDiscardedPortions" ),
 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
     m_option_mean_monitorPeriod       (m_prefix + "mean_monitorPeriod"       ),
     m_option_bmm_run                  (m_prefix + "bmm_run"                  ),
     m_option_bmm_lengths              (m_prefix + "bmm_lengths"              ),
     m_option_bmm_display              (m_prefix + "bmm_display"              ),
     m_option_bmm_write                (m_prefix + "bmm_write"                ),
     m_option_fft_compute              (m_prefix + "fft_compute"              ),
     m_option_fft_paramId              (m_prefix + "fft_paramId"              ),
     m_option_fft_size                 (m_prefix + "fft_size"                 ),
     m_option_fft_testInversion        (m_prefix + "fft_testInversion"        ),
     m_option_fft_write                (m_prefix + "fft_write"                ),
     m_option_psd_compute              (m_prefix + "psd_compute"              ),
     m_option_psd_numBlocks            (m_prefix + "psd_numBlocks"            ),
     m_option_psd_hopSizeRatio         (m_prefix + "psd_hopSizeRatio"         ),
     m_option_psd_paramId              (m_prefix + "psd_paramId"              ),
     m_option_psd_write                (m_prefix + "psd_write"                ),
     m_option_psdAtZero_compute        (m_prefix + "psdAtZero_compute"        ),
     m_option_psdAtZero_numBlocks      (m_prefix + "psdAtZero_numBlocks"      ),
     m_option_psdAtZero_hopSizeRatio   (m_prefix + "psdAtZero_hopSizeRatio"   ),
     m_option_psdAtZero_display        (m_prefix + "psdAtZero_display"        ),
     m_option_psdAtZero_write          (m_prefix + "psdAtZero_write"          ),
     m_option_geweke_compute           (m_prefix + "geweke_compute"           ),
     m_option_geweke_naRatio           (m_prefix + "geweke_naRatio"           ),
     m_option_geweke_nbRatio           (m_prefix + "geweke_nbRatio"           ),
     m_option_geweke_display           (m_prefix + "geweke_display"           ),
     m_option_geweke_write             (m_prefix + "geweke_write"             ),
     m_option_meanStacc_compute        (m_prefix + "meanStacc_compute"        ),
     m_option_hist_compute             (m_prefix + "hist_compute"             ),
     m_option_hist_numInternalBins     (m_prefix + "hist_numInternalBins"     ),
     m_option_cdfStacc_compute         (m_prefix + "cdfStacc_compute"         ),
     m_option_cdfStacc_numEvalPositions(m_prefix + "cdfStacc_numEvalPositions"),
 #endif
     m_option_autoCorr_computeViaDef   (m_prefix + "autoCorr_computeViaDef"   ),
     m_option_autoCorr_computeViaFft   (m_prefix + "autoCorr_computeViaFft"   ),
     m_option_autoCorr_secondLag       (m_prefix + "autoCorr_secondLag"       ),
     m_option_autoCorr_lagSpacing      (m_prefix + "autoCorr_lagSpacing"      ),
     m_option_autoCorr_numLags         (m_prefix + "autoCorr_numLags"         ),
     m_option_autoCorr_display         (m_prefix + "autoCorr_display"         ),
     m_option_autoCorr_write           (m_prefix + "autoCorr_write"           ),
     m_option_kde_compute              (m_prefix + "kde_compute"              ),
     m_option_kde_numEvalPositions     (m_prefix + "kde_numEvalPositions"     ),
     m_option_covMatrix_compute        (m_prefix + "covMatrix_compute"        ),
     m_option_corrMatrix_compute       (m_prefix + "corrMatrix_compute"       )
 {
   (m_option_help,                                                                                                                    "produce help message for chain statistical options"             )
   (m_option_initialDiscardedPortions,       boost::program_options::value<std::string >()->default_value(UQ_SEQUENCE_INITIAL_DISCARDED_PORTIONS_ODV      ), "list of initial discarded portions for chain statistics"        )
 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
   m_parser->registerOption(m_option_mean_monitorPeriod,             UQ_SEQUENCE_MEAN_MONITOR_PERIOD_ODV, "period for monitoring mean"                                     );
   m_parser->registerOption(m_option_bmm_run,                        UQ_SEQUENCE_BMM_RUN_ODV            , "compute variance of sample mean with batch means method"        );
   m_parser->registerOption<std::string>(m_option_bmm_lengths,                    UQ_SEQUENCE_BMM_LENGTHS_ODV        , "list of batch lenghts for BMM"                                  );
   m_parser->registerOption(m_option_fft_compute,                    UQ_SEQUENCE_FFT_COMPUTE_ODV        , "compute fft"                                                    );
   m_parser->registerOption(m_option_fft_paramId,                    UQ_SEQUENCE_FFT_PARAM_ID_ODV       , "parameter id for fft computations"                              );
   m_parser->registerOption(m_option_fft_size,                       UQ_SEQUENCE_FFT_SIZE_ODV           , "fft size"                                                       );
   m_parser->registerOption(m_option_fft_testInversion,              UQ_SEQUENCE_FFT_TEST_INVERSION_ODV , "test fft inversion"                                             );
   m_parser->registerOption(m_option_fft_write,                      UQ_SEQUENCE_FFT_WRITE_ODV          , "write fft"                                                      );
   m_parser->registerOption(m_option_psd_compute,                    UQ_SEQUENCE_PSD_COMPUTE_ODV        , "compute psd"                                                    );
   m_parser->registerOption(m_option_psd_numBlocks,                  UQ_SEQUENCE_PSD_NUM_BLOCKS_ODV     , "number of blocks for computation of psd"                        );
   m_parser->registerOption(m_option_psd_hopSizeRatio,               UQ_SEQUENCE_PSD_HOP_SIZE_RATIO_ODV , "hop size ratio for psd"                                         );
   m_parser->registerOption(m_option_psd_paramId,                    UQ_SEQUENCE_PSD_PARAM_ID_ODV       , "parameter id for psd computations"                              );
   m_parser->registerOption(m_option_psd_write,                      UQ_SEQUENCE_PSD_WRITE_ODV          , "write psd"                                                      );
   m_parser->registerOption(m_option_psdAtZero_compute,              UQ_SEQUENCE_PSD_AT_ZERO_COMPUTE_ODV, "compute power spectral densities"                               );
   m_parser->registerOption<std::string>(m_option_psdAtZero_numBlocks,            UQ_SEQUENCE_PSD_AT_ZERO_NUM_BLOCKS_ODV          , "list of numbers of blocks for computation of psd at zero"       );
   m_parser->registerOption(m_option_psdAtZero_hopSizeRatio,         UQ_SEQUENCE_PSD_AT_ZERO_HOP_SIZE_RATIO_ODV      , "hop size ratio for psd at zero"                                 );
   m_parser->registerOption(m_option_psdAtZero_display,              UQ_SEQUENCE_PSD_AT_ZERO_DISPLAY_ODV, "display computed psd at frequency zero on screen"               );
   m_parser->registerOption(m_option_psdAtZero_write,                UQ_SEQUENCE_PSD_AT_ZERO_WRITE_ODV  , "write computed psd at frequency zero to the output file"        );
   m_parser->registerOption(m_option_geweke_compute,                 UQ_SEQUENCE_GEWEKE_COMPUTE_ODV     , "compute Geweke coefficients"                                    );
   m_parser->registerOption(m_option_geweke_naRatio,                 UQ_SEQUENCE_GEWEKE_NA_RATIO_ODV    , "ratio NA for Geweke"                                            );
   m_parser->registerOption(m_option_geweke_nbRatio,                 UQ_SEQUENCE_GEWEKE_NB_RATIO_ODV    , "ratio NB for Geweke"                                            );
   m_parser->registerOption(m_option_geweke_display,                 UQ_SEQUENCE_GEWEKE_DISPLAY_ODV     , "display computed Geweke on screen"                              );
   m_parser->registerOption(m_option_geweke_write,                   UQ_SEQUENCE_GEWEKE_WRITE_ODV       , "write computed Geweke to the output file"                       );
   m_parser->registerOption(m_option_meanStacc_compute,              UQ_SEQUENCE_MEAN_STACC_COMPUTE_ODV , "compute statistical accuracy of mean"                           );
   m_parser->registerOption(m_option_hist_compute,                   UQ_SEQUENCE_HIST_COMPUTE_ODV       , "compute histograms"                                             );
   m_parser->registerOption(m_option_hist_numInternalBins,           UQ_SEQUENCE_HIST_NUM_INTERNAL_BINS_ODV          , "number of internal bins"                                        );
   m_parser->registerOption(m_option_cdfStacc_compute,               UQ_SEQUENCE_CDF_STACC_COMPUTE_ODV  , "compute statisical accuracy of cdf"                             );
   m_parser->registerOption(m_option_cdfStacc_numEvalPositions,      UQ_SEQUENCE_CDF_STACC_NUM_EVAL_POSITIONS_ODV    , "number of evaluations points for statistical accuracy of cdf"   );
 #endif
   m_parser->registerOption(m_option_autoCorr_computeViaDef,         boost::program_options::value<bool        >()->default_value(UQ_SEQUENCE_AUTO_CORR_COMPUTE_VIA_DEF_ODV       ), "compute correlations via definition"                            )
   m_parser->registerOption(m_option_autoCorr_computeViaFft,         boost::program_options::value<bool        >()->default_value(UQ_SEQUENCE_AUTO_CORR_COMPUTE_VIA_FFT_ODV       ), "compute correlations via fft"                                   )
   m_parser->registerOption(m_option_autoCorr_secondLag,             boost::program_options::value<unsigned int>()->default_value(UQ_SEQUENCE_AUTO_CORR_SECOND_LAG_ODV            ), "second lag for computation of autocorrelations"                 )
   m_parser->registerOption(m_option_autoCorr_lagSpacing,            boost::program_options::value<unsigned int>()->default_value(UQ_SEQUENCE_AUTO_CORR_LAG_SPACING_ODV           ), "lag spacing for computation of autocorrelations"                )
   m_parser->registerOption(m_option_autoCorr_numLags,               boost::program_options::value<unsigned int>()->default_value(UQ_SEQUENCE_AUTO_CORR_NUM_LAGS_ODV              ), "number of lags for computation of autocorrelations"             )
   m_parser->registerOption(m_option_autoCorr_display,               boost::program_options::value<bool        >()->default_value(UQ_SEQUENCE_AUTO_CORR_DISPLAY_ODV               ), "display computed autocorrelations on the screen"                )
   m_parser->registerOption(m_option_autoCorr_write,                 boost::program_options::value<bool        >()->default_value(UQ_SEQUENCE_AUTO_CORR_WRITE_ODV                 ), "write computed autocorrelations to the output file"             )
   m_parser->registerOption(m_option_kde_compute,                    boost::program_options::value<bool        >()->default_value(UQ_SEQUENCE_KDE_COMPUTE_ODV                     ), "compute kernel density estimators"                              )
   m_parser->registerOption(m_option_kde_numEvalPositions,           boost::program_options::value<unsigned int>()->default_value(UQ_SEQUENCE_KDE_NUM_EVAL_POSITIONS_ODV          ), "number of evaluation positions"                                 )
   m_parser->registerOption(m_option_covMatrix_compute,              boost::program_options::value<bool        >()->default_value(UQ_SEQUENCE_COV_MATRIX_COMPUTE_ODV              ), "compute covariance matrix"                                      )
   m_parser->registerOption(m_option_corrMatrix_compute,             boost::program_options::value<bool        >()->default_value(UQ_SEQUENCE_CORR_MATRIX_COMPUTE_ODV             ), "compute correlation matrix"                                     )
 }

SsOptionsValues::SsOptionsValues ( const SsOptionsValues & src )

Copy constructor.

It assigns to this' variables, the same values of the variable of src.

Definition at line 272 of file SequenceStatisticalOptions.C.

References copy().

 {
   this->copy(src);
 }

SsOptionsValues::~SsOptionsValues ( )

virtual

Destructor.

Definition at line 268 of file SequenceStatisticalOptions.C.

269 {

270 }

Member Function Documentation

void SsOptionsValues::copy ( const SsOptionsValues & src )

private

Copies the option values from src to this.

Definition at line 558 of file SequenceStatisticalOptions.C.

References m_autoCorrComputeViaDef, m_autoCorrComputeViaFft, m_autoCorrDisplay, m_autoCorrLagSpacing, m_autoCorrNumLags, m_autoCorrSecondLag, m_autoCorrWrite, m_bmmLengths, m_bmmRun, m_cdfStaccCompute, m_cdfStaccNumEvalPositions, m_corrMatrixCompute, m_covMatrixCompute, m_fftCompute, m_fftParamId, m_fftSize, m_fftTestInversion, m_fftWrite, m_gewekeCompute, m_gewekeDisplay, m_gewekeNaRatio, m_gewekeNbRatio, m_gewekeWrite, m_histCompute, m_histNumInternalBins, m_initialDiscardedPortions, m_kdeCompute, m_kdeNumEvalPositions, m_meanMonitorPeriod, m_meanStaccCompute, m_psdAtZeroCompute, m_psdAtZeroDisplay, m_psdAtZeroHopSizeRatio, m_psdAtZeroNumBlocks, m_psdAtZeroWrite, m_psdCompute, m_psdHopSizeRatio, m_psdNumBlocks, m_psdParamId, and m_psdWrite.

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

 {
   m_initialDiscardedPortions = src.m_initialDiscardedPortions;
 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
   m_meanMonitorPeriod        = src.m_meanMonitorPeriod;
   m_bmmRun                   = src.m_bmmRun;
   m_bmmLengths               = src.m_bmmLengths;
   m_fftCompute               = src.m_fftCompute;
   m_fftParamId               = src.m_fftParamId;
   m_fftSize                  = src.m_fftSize;
   m_fftTestInversion         = src.m_fftTestInversion;
   m_fftWrite                 = src.m_fftWrite;
   m_psdCompute               = src.m_psdCompute;
   m_psdNumBlocks             = src.m_psdNumBlocks;
   m_psdHopSizeRatio          = src.m_psdHopSizeRatio;
   m_psdParamId               = src.m_psdParamId;
   m_psdWrite                 = src.m_psdWrite;
   m_psdAtZeroCompute         = src.m_psdAtZeroCompute;
   m_psdAtZeroNumBlocks       = src.m_psdAtZeroNumBlocks;
   m_psdAtZeroHopSizeRatio    = src.m_psdAtZeroHopSizeRatio;
   m_psdAtZeroDisplay         = src.m_psdAtZeroDisplay;
   m_psdAtZeroWrite           = src.m_psdAtZeroWrite;
   m_gewekeCompute            = src.m_gewekeCompute;
   m_gewekeNaRatio            = src.m_gewekeNaRatio;
   m_gewekeNbRatio            = src.m_gewekeNbRatio;
   m_gewekeDisplay            = src.m_gewekeDisplay;
   m_gewekeWrite              = src.m_gewekeWrite;
   m_meanStaccCompute         = src.m_meanStaccCompute;
   m_histCompute              = src.m_histCompute;
   m_histNumInternalBins      = src.m_histNumInternalBins;
   m_cdfStaccCompute          = src.m_cdfStaccCompute;
   m_cdfStaccNumEvalPositions = src.m_cdfStaccNumEvalPositions;
 #endif
   m_autoCorrComputeViaDef    = src.m_autoCorrComputeViaDef;
   m_autoCorrComputeViaFft    = src.m_autoCorrComputeViaFft;
   m_autoCorrSecondLag        = src.m_autoCorrSecondLag;
   m_autoCorrLagSpacing       = src.m_autoCorrLagSpacing;
   m_autoCorrNumLags          = src.m_autoCorrNumLags;
   m_autoCorrDisplay          = src.m_autoCorrDisplay;
   m_autoCorrWrite            = src.m_autoCorrWrite;
   m_kdeCompute               = src.m_kdeCompute;
   m_kdeNumEvalPositions      = src.m_kdeNumEvalPositions;
   m_covMatrixCompute         = src.m_covMatrixCompute;
   m_corrMatrixCompute        = src.m_corrMatrixCompute;
 
   return;
 }

SsOptionsValues & SsOptionsValues::operator= ( const SsOptionsValues & rhs )

Assignment operator; it copies rhs to this.

Definition at line 278 of file SequenceStatisticalOptions.C.

References copy().

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

Member Data Documentation

bool SsOptionsValues::m_autoCorrComputeViaDef

Whether or not compute autocorrelation via definition.

Definition at line 130 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::autoCorrComputeViaDef(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_autoCorrComputeViaFft

Whether or not compute autocorrelation via FFT.

Definition at line 133 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::autoCorrComputeViaFft(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_autoCorrDisplay

Whether or not display autocorrelation.

Definition at line 145 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::autoCorrDisplay(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

unsigned int SsOptionsValues::m_autoCorrLagSpacing

Lag spacing of the autocorrelation.

Definition at line 139 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::autoCorrLagSpacing(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

unsigned int SsOptionsValues::m_autoCorrNumLags

Number of lags of the autocorrelation.

Definition at line 142 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::autoCorrNumLags(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

unsigned int SsOptionsValues::m_autoCorrSecondLag

Second lag of the autocorrelation.

Definition at line 136 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::autoCorrSecondLag(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_autoCorrWrite

Whether or not write autocorrelation to file.

Definition at line 148 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::autoCorrWrite(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_bmmDisplay

Definition at line 167 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::bmmDisplay().

std::vector<unsigned int> SsOptionsValues::m_bmmLengths

Definition at line 166 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::bmmLengths(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_bmmRun

Definition at line 165 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::bmmRun(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_bmmWrite

Definition at line 168 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::bmmWrite().

bool SsOptionsValues::m_cdfStaccCompute

Definition at line 199 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::cdfStaccCompute(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

unsigned int SsOptionsValues::m_cdfStaccNumEvalPositions

Definition at line 200 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::cdfStaccNumEvalPositions(), copy(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_corrMatrixCompute

Whether or not compute correlation matrix.

Definition at line 160 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::corrMatrixCompute(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_covMatrixCompute

Whether or not compute covariance matrix.

Definition at line 157 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::covMatrixCompute(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_fftCompute

Definition at line 170 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::fftCompute(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

unsigned int SsOptionsValues::m_fftParamId

Definition at line 171 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::fftParamId(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

unsigned int SsOptionsValues::m_fftSize

Definition at line 172 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::fftSize(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_fftTestInversion

Definition at line 173 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::fftTestInversion(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_fftWrite

Definition at line 174 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::fftWrite(), SequenceStatisticalOptions::getMyOptionValues(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_gewekeCompute

Definition at line 188 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::gewekeCompute(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_gewekeDisplay

Definition at line 191 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::gewekeDisplay(), and SequenceStatisticalOptions::print().

double SsOptionsValues::m_gewekeNaRatio

Definition at line 189 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::gewekeNaRatio(), and SequenceStatisticalOptions::print().

double SsOptionsValues::m_gewekeNbRatio

Definition at line 190 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::gewekeNbRatio(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_gewekeWrite

Definition at line 192 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::gewekeWrite(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_histCompute

Definition at line 196 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::histCompute(), and SequenceStatisticalOptions::print().

unsigned int SsOptionsValues::m_histNumInternalBins

Definition at line 197 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::histNumInternalBins(), and SequenceStatisticalOptions::print().

std::vector<double> SsOptionsValues::m_initialDiscardedPortions

Stores the initial discarded portion of the chain.

Definition at line 127 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::initialDiscardedPortions(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_kdeCompute

Whether or not compute kernel density estimate (kde).

Definition at line 151 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::kdeCompute(), and SequenceStatisticalOptions::print().

unsigned int SsOptionsValues::m_kdeNumEvalPositions

Number of positions to evaluate kde.

Definition at line 154 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::kdeNumEvalPositions(), and SequenceStatisticalOptions::print().

unsigned int SsOptionsValues::m_meanMonitorPeriod

Definition at line 163 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::meanMonitorPeriod(), and SequenceStatisticalOptions::print().

bool SsOptionsValues::m_meanStaccCompute

Definition at line 194 of file SequenceStatisticalOptions.h.

Referenced by copy(), SequenceStatisticalOptions::getMyOptionValues(), SequenceStatisticalOptions::meanStaccCompute(), and SequenceStatisticalOptions::print().

std::string SsOptionsValues::m_option_autoCorr_computeViaDef

private

Definition at line 210 of file SequenceStatisticalOptions.h.

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation