queso-0.57.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
SsOptionsValues Class Reference

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
SsOptionsValuesoperator= (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.

38  :
39  m_prefix ("stats_"),
40  m_initialDiscardedPortions(0 ),//,0.),
41 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
42  m_meanMonitorPeriod (UQ_SEQUENCE_MEAN_MONITOR_PERIOD_ODV ),
43  m_bmmRun (UQ_SEQUENCE_BMM_RUN_ODV ),
44  m_bmmLengths (0 ),//,0),
45  m_fftCompute (UQ_SEQUENCE_FFT_COMPUTE_ODV ),
46  m_fftParamId (UQ_SEQUENCE_FFT_PARAM_ID_ODV ),
47  m_fftSize (UQ_SEQUENCE_FFT_SIZE_ODV ),
48  m_fftTestInversion (UQ_SEQUENCE_FFT_TEST_INVERSION_ODV ),
49  m_fftWrite (UQ_SEQUENCE_FFT_WRITE_ODV ),
50  m_psdCompute (UQ_SEQUENCE_PSD_COMPUTE_ODV ),
51  m_psdNumBlocks (UQ_SEQUENCE_PSD_NUM_BLOCKS_ODV ),
52  m_psdHopSizeRatio (UQ_SEQUENCE_PSD_HOP_SIZE_RATIO_ODV ),
53  m_psdParamId (UQ_SEQUENCE_PSD_PARAM_ID_ODV ),
54  m_psdWrite (UQ_SEQUENCE_PSD_WRITE_ODV ),
55  m_psdAtZeroCompute (UQ_SEQUENCE_PSD_AT_ZERO_COMPUTE_ODV ),
56  m_psdAtZeroNumBlocks (0 ),//,0),
57  m_psdAtZeroHopSizeRatio (UQ_SEQUENCE_PSD_AT_ZERO_HOP_SIZE_RATIO_ODV ),
58  m_psdAtZeroDisplay (UQ_SEQUENCE_PSD_AT_ZERO_DISPLAY_ODV ),
59  m_psdAtZeroWrite (UQ_SEQUENCE_PSD_AT_ZERO_WRITE_ODV ),
60  m_gewekeCompute (UQ_SEQUENCE_GEWEKE_COMPUTE_ODV ),
61  m_gewekeNaRatio (UQ_SEQUENCE_GEWEKE_NA_RATIO_ODV ),
62  m_gewekeNbRatio (UQ_SEQUENCE_GEWEKE_NB_RATIO_ODV ),
63  m_gewekeDisplay (UQ_SEQUENCE_GEWEKE_DISPLAY_ODV ),
64  m_gewekeWrite (UQ_SEQUENCE_GEWEKE_WRITE_ODV ),
65  m_meanStaccCompute (UQ_SEQUENCE_MEAN_STACC_COMPUTE_ODV ),
66  m_histCompute (UQ_SEQUENCE_HIST_COMPUTE_ODV ),
67  m_histNumInternalBins (UQ_SEQUENCE_HIST_NUM_INTERNAL_BINS_ODV ),
68  m_cdfStaccCompute (UQ_SEQUENCE_CDF_STACC_COMPUTE_ODV ),
69  m_cdfStaccNumEvalPositions(UQ_SEQUENCE_CDF_STACC_NUM_EVAL_POSITIONS_ODV),
70 #endif
71  m_autoCorrComputeViaDef (UQ_SEQUENCE_AUTO_CORR_COMPUTE_VIA_DEF_ODV ),
72  m_autoCorrComputeViaFft (UQ_SEQUENCE_AUTO_CORR_COMPUTE_VIA_FFT_ODV ),
73  m_autoCorrSecondLag (UQ_SEQUENCE_AUTO_CORR_SECOND_LAG_ODV ),
74  m_autoCorrLagSpacing (UQ_SEQUENCE_AUTO_CORR_LAG_SPACING_ODV ),
75  m_autoCorrNumLags (UQ_SEQUENCE_AUTO_CORR_NUM_LAGS_ODV ),
76  m_autoCorrDisplay (UQ_SEQUENCE_AUTO_CORR_DISPLAY_ODV ),
77  m_autoCorrWrite (UQ_SEQUENCE_AUTO_CORR_WRITE_ODV ),
78  m_kdeCompute (UQ_SEQUENCE_KDE_COMPUTE_ODV ),
79  m_kdeNumEvalPositions (UQ_SEQUENCE_KDE_NUM_EVAL_POSITIONS_ODV ),
80  m_covMatrixCompute (UQ_SEQUENCE_COV_MATRIX_COMPUTE_ODV ),
81  m_corrMatrixCompute (UQ_SEQUENCE_CORR_MATRIX_COMPUTE_ODV ),
82  m_option_help (m_prefix + "help" ),
83  m_option_initialDiscardedPortions (m_prefix + "initialDiscardedPortions" ),
84 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
85  m_option_mean_monitorPeriod (m_prefix + "mean_monitorPeriod" ),
86  m_option_bmm_run (m_prefix + "bmm_run" ),
87  m_option_bmm_lengths (m_prefix + "bmm_lengths" ),
88  m_option_bmm_display (m_prefix + "bmm_display" ),
89  m_option_bmm_write (m_prefix + "bmm_write" ),
90  m_option_fft_compute (m_prefix + "fft_compute" ),
91  m_option_fft_paramId (m_prefix + "fft_paramId" ),
92  m_option_fft_size (m_prefix + "fft_size" ),
93  m_option_fft_testInversion (m_prefix + "fft_testInversion" ),
94  m_option_fft_write (m_prefix + "fft_write" ),
95  m_option_psd_compute (m_prefix + "psd_compute" ),
96  m_option_psd_numBlocks (m_prefix + "psd_numBlocks" ),
97  m_option_psd_hopSizeRatio (m_prefix + "psd_hopSizeRatio" ),
98  m_option_psd_paramId (m_prefix + "psd_paramId" ),
99  m_option_psd_write (m_prefix + "psd_write" ),
100  m_option_psdAtZero_compute (m_prefix + "psdAtZero_compute" ),
101  m_option_psdAtZero_numBlocks (m_prefix + "psdAtZero_numBlocks" ),
102  m_option_psdAtZero_hopSizeRatio (m_prefix + "psdAtZero_hopSizeRatio" ),
103  m_option_psdAtZero_display (m_prefix + "psdAtZero_display" ),
104  m_option_psdAtZero_write (m_prefix + "psdAtZero_write" ),
105  m_option_geweke_compute (m_prefix + "geweke_compute" ),
106  m_option_geweke_naRatio (m_prefix + "geweke_naRatio" ),
107  m_option_geweke_nbRatio (m_prefix + "geweke_nbRatio" ),
108  m_option_geweke_display (m_prefix + "geweke_display" ),
109  m_option_geweke_write (m_prefix + "geweke_write" ),
110  m_option_meanStacc_compute (m_prefix + "meanStacc_compute" ),
111  m_option_hist_compute (m_prefix + "hist_compute" ),
112  m_option_hist_numInternalBins (m_prefix + "hist_numInternalBins" ),
113  m_option_cdfStacc_compute (m_prefix + "cdfStacc_compute" ),
114  m_option_cdfStacc_numEvalPositions(m_prefix + "cdfStacc_numEvalPositions"),
115 #endif
116  m_option_autoCorr_computeViaDef (m_prefix + "autoCorr_computeViaDef" ),
117  m_option_autoCorr_computeViaFft (m_prefix + "autoCorr_computeViaFft" ),
118  m_option_autoCorr_secondLag (m_prefix + "autoCorr_secondLag" ),
119  m_option_autoCorr_lagSpacing (m_prefix + "autoCorr_lagSpacing" ),
120  m_option_autoCorr_numLags (m_prefix + "autoCorr_numLags" ),
121  m_option_autoCorr_display (m_prefix + "autoCorr_display" ),
122  m_option_autoCorr_write (m_prefix + "autoCorr_write" ),
123  m_option_kde_compute (m_prefix + "kde_compute" ),
124  m_option_kde_numEvalPositions (m_prefix + "kde_numEvalPositions" ),
125  m_option_covMatrix_compute (m_prefix + "covMatrix_compute" ),
126  m_option_corrMatrix_compute (m_prefix + "corrMatrix_compute" )
127 {
128 }
std::string m_option_autoCorr_computeViaFft
std::string m_option_kde_numEvalPositions
std::string m_option_fft_testInversion
std::string m_option_cdfStacc_numEvalPositions
std::string m_option_psdAtZero_compute
std::string m_option_initialDiscardedPortions
std::vector< unsigned int > m_bmmLengths
std::string m_option_meanStacc_compute
std::string m_option_psdAtZero_hopSizeRatio
unsigned int m_cdfStaccNumEvalPositions
std::string m_option_psdAtZero_numBlocks
bool m_corrMatrixCompute
Whether or not compute correlation matrix.
std::vector< double > m_initialDiscardedPortions
Stores the initial discarded portion of the chain.
std::string m_option_hist_numInternalBins
std::string m_option_psdAtZero_display
std::string m_option_mean_monitorPeriod
std::vector< unsigned int > m_psdAtZeroNumBlocks
std::string m_option_autoCorr_computeViaDef
unsigned int m_kdeNumEvalPositions
Number of positions to evaluate kde.
unsigned int m_autoCorrLagSpacing
Lag spacing of the autocorrelation.
bool m_covMatrixCompute
Whether or not compute covariance matrix.
bool m_kdeCompute
Whether or not compute kernel density estimate (kde).
bool m_autoCorrWrite
Whether or not write autocorrelation to file.
bool m_autoCorrDisplay
Whether or not display autocorrelation.
unsigned int m_autoCorrSecondLag
Second lag of the autocorrelation.
bool m_autoCorrComputeViaDef
Whether or not compute autocorrelation via definition.
std::string m_option_covMatrix_compute
unsigned int m_autoCorrNumLags
Number of lags of the autocorrelation.
bool m_autoCorrComputeViaFft
Whether or not compute autocorrelation via FFT.
std::string m_option_autoCorr_secondLag
std::string m_option_corrMatrix_compute
std::string m_option_autoCorr_lagSpacing
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.

132  :
133  m_prefix ((std::string)(prefix) + "stats_"),
134  m_initialDiscardedPortions(0 ),//,0.),
135 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
136  m_meanMonitorPeriod (UQ_SEQUENCE_MEAN_MONITOR_PERIOD_ODV ),
137  m_bmmRun (UQ_SEQUENCE_BMM_RUN_ODV ),
138  m_bmmLengths (0 ),//,0),
139  m_fftCompute (UQ_SEQUENCE_FFT_COMPUTE_ODV ),
140  m_fftParamId (UQ_SEQUENCE_FFT_PARAM_ID_ODV ),
141  m_fftSize (UQ_SEQUENCE_FFT_SIZE_ODV ),
142  m_fftTestInversion (UQ_SEQUENCE_FFT_TEST_INVERSION_ODV ),
143  m_fftWrite (UQ_SEQUENCE_FFT_WRITE_ODV ),
144  m_psdCompute (UQ_SEQUENCE_PSD_COMPUTE_ODV ),
145  m_psdNumBlocks (UQ_SEQUENCE_PSD_NUM_BLOCKS_ODV ),
146  m_psdHopSizeRatio (UQ_SEQUENCE_PSD_HOP_SIZE_RATIO_ODV ),
147  m_psdParamId (UQ_SEQUENCE_PSD_PARAM_ID_ODV ),
148  m_psdWrite (UQ_SEQUENCE_PSD_WRITE_ODV ),
149  m_psdAtZeroCompute (UQ_SEQUENCE_PSD_AT_ZERO_COMPUTE_ODV ),
150  m_psdAtZeroNumBlocks (0 ),//,0),
151  m_psdAtZeroHopSizeRatio (UQ_SEQUENCE_PSD_AT_ZERO_HOP_SIZE_RATIO_ODV ),
152  m_psdAtZeroDisplay (UQ_SEQUENCE_PSD_AT_ZERO_DISPLAY_ODV ),
153  m_psdAtZeroWrite (UQ_SEQUENCE_PSD_AT_ZERO_WRITE_ODV ),
154  m_gewekeCompute (UQ_SEQUENCE_GEWEKE_COMPUTE_ODV ),
155  m_gewekeNaRatio (UQ_SEQUENCE_GEWEKE_NA_RATIO_ODV ),
156  m_gewekeNbRatio (UQ_SEQUENCE_GEWEKE_NB_RATIO_ODV ),
157  m_gewekeDisplay (UQ_SEQUENCE_GEWEKE_DISPLAY_ODV ),
158  m_gewekeWrite (UQ_SEQUENCE_GEWEKE_WRITE_ODV ),
159  m_meanStaccCompute (UQ_SEQUENCE_MEAN_STACC_COMPUTE_ODV ),
160  m_histCompute (UQ_SEQUENCE_HIST_COMPUTE_ODV ),
161  m_histNumInternalBins (UQ_SEQUENCE_HIST_NUM_INTERNAL_BINS_ODV ),
162  m_cdfStaccCompute (UQ_SEQUENCE_CDF_STACC_COMPUTE_ODV ),
163  m_cdfStaccNumEvalPositions(UQ_SEQUENCE_CDF_STACC_NUM_EVAL_POSITIONS_ODV),
164 #endif
165  m_autoCorrComputeViaDef (UQ_SEQUENCE_AUTO_CORR_COMPUTE_VIA_DEF_ODV ),
166  m_autoCorrComputeViaFft (UQ_SEQUENCE_AUTO_CORR_COMPUTE_VIA_FFT_ODV ),
167  m_autoCorrSecondLag (UQ_SEQUENCE_AUTO_CORR_SECOND_LAG_ODV ),
168  m_autoCorrLagSpacing (UQ_SEQUENCE_AUTO_CORR_LAG_SPACING_ODV ),
169  m_autoCorrNumLags (UQ_SEQUENCE_AUTO_CORR_NUM_LAGS_ODV ),
170  m_autoCorrDisplay (UQ_SEQUENCE_AUTO_CORR_DISPLAY_ODV ),
171  m_autoCorrWrite (UQ_SEQUENCE_AUTO_CORR_WRITE_ODV ),
172  m_kdeCompute (UQ_SEQUENCE_KDE_COMPUTE_ODV ),
173  m_kdeNumEvalPositions (UQ_SEQUENCE_KDE_NUM_EVAL_POSITIONS_ODV ),
174  m_covMatrixCompute (UQ_SEQUENCE_COV_MATRIX_COMPUTE_ODV ),
175  m_corrMatrixCompute (UQ_SEQUENCE_CORR_MATRIX_COMPUTE_ODV ),
176  m_parser(new BoostInputOptionsParser(env->optionsInputFileName())),
177  m_option_help (m_prefix + "help" ),
178  m_option_initialDiscardedPortions (m_prefix + "initialDiscardedPortions" ),
179 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
180  m_option_mean_monitorPeriod (m_prefix + "mean_monitorPeriod" ),
181  m_option_bmm_run (m_prefix + "bmm_run" ),
182  m_option_bmm_lengths (m_prefix + "bmm_lengths" ),
183  m_option_bmm_display (m_prefix + "bmm_display" ),
184  m_option_bmm_write (m_prefix + "bmm_write" ),
185  m_option_fft_compute (m_prefix + "fft_compute" ),
186  m_option_fft_paramId (m_prefix + "fft_paramId" ),
187  m_option_fft_size (m_prefix + "fft_size" ),
188  m_option_fft_testInversion (m_prefix + "fft_testInversion" ),
189  m_option_fft_write (m_prefix + "fft_write" ),
190  m_option_psd_compute (m_prefix + "psd_compute" ),
191  m_option_psd_numBlocks (m_prefix + "psd_numBlocks" ),
192  m_option_psd_hopSizeRatio (m_prefix + "psd_hopSizeRatio" ),
193  m_option_psd_paramId (m_prefix + "psd_paramId" ),
194  m_option_psd_write (m_prefix + "psd_write" ),
195  m_option_psdAtZero_compute (m_prefix + "psdAtZero_compute" ),
196  m_option_psdAtZero_numBlocks (m_prefix + "psdAtZero_numBlocks" ),
197  m_option_psdAtZero_hopSizeRatio (m_prefix + "psdAtZero_hopSizeRatio" ),
198  m_option_psdAtZero_display (m_prefix + "psdAtZero_display" ),
199  m_option_psdAtZero_write (m_prefix + "psdAtZero_write" ),
200  m_option_geweke_compute (m_prefix + "geweke_compute" ),
201  m_option_geweke_naRatio (m_prefix + "geweke_naRatio" ),
202  m_option_geweke_nbRatio (m_prefix + "geweke_nbRatio" ),
203  m_option_geweke_display (m_prefix + "geweke_display" ),
204  m_option_geweke_write (m_prefix + "geweke_write" ),
205  m_option_meanStacc_compute (m_prefix + "meanStacc_compute" ),
206  m_option_hist_compute (m_prefix + "hist_compute" ),
207  m_option_hist_numInternalBins (m_prefix + "hist_numInternalBins" ),
208  m_option_cdfStacc_compute (m_prefix + "cdfStacc_compute" ),
209  m_option_cdfStacc_numEvalPositions(m_prefix + "cdfStacc_numEvalPositions"),
210 #endif
211  m_option_autoCorr_computeViaDef (m_prefix + "autoCorr_computeViaDef" ),
212  m_option_autoCorr_computeViaFft (m_prefix + "autoCorr_computeViaFft" ),
213  m_option_autoCorr_secondLag (m_prefix + "autoCorr_secondLag" ),
214  m_option_autoCorr_lagSpacing (m_prefix + "autoCorr_lagSpacing" ),
215  m_option_autoCorr_numLags (m_prefix + "autoCorr_numLags" ),
216  m_option_autoCorr_display (m_prefix + "autoCorr_display" ),
217  m_option_autoCorr_write (m_prefix + "autoCorr_write" ),
218  m_option_kde_compute (m_prefix + "kde_compute" ),
219  m_option_kde_numEvalPositions (m_prefix + "kde_numEvalPositions" ),
220  m_option_covMatrix_compute (m_prefix + "covMatrix_compute" ),
221  m_option_corrMatrix_compute (m_prefix + "corrMatrix_compute" )
222 {
223  (m_option_help, "produce help message for chain statistical options" )
224  (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" )
225 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
226  m_parser->registerOption(m_option_mean_monitorPeriod, UQ_SEQUENCE_MEAN_MONITOR_PERIOD_ODV, "period for monitoring mean" );
227  m_parser->registerOption(m_option_bmm_run, UQ_SEQUENCE_BMM_RUN_ODV , "compute variance of sample mean with batch means method" );
228  m_parser->registerOption<std::string>(m_option_bmm_lengths, UQ_SEQUENCE_BMM_LENGTHS_ODV , "list of batch lenghts for BMM" );
229  m_parser->registerOption(m_option_fft_compute, UQ_SEQUENCE_FFT_COMPUTE_ODV , "compute fft" );
230  m_parser->registerOption(m_option_fft_paramId, UQ_SEQUENCE_FFT_PARAM_ID_ODV , "parameter id for fft computations" );
231  m_parser->registerOption(m_option_fft_size, UQ_SEQUENCE_FFT_SIZE_ODV , "fft size" );
232  m_parser->registerOption(m_option_fft_testInversion, UQ_SEQUENCE_FFT_TEST_INVERSION_ODV , "test fft inversion" );
233  m_parser->registerOption(m_option_fft_write, UQ_SEQUENCE_FFT_WRITE_ODV , "write fft" );
234  m_parser->registerOption(m_option_psd_compute, UQ_SEQUENCE_PSD_COMPUTE_ODV , "compute psd" );
235  m_parser->registerOption(m_option_psd_numBlocks, UQ_SEQUENCE_PSD_NUM_BLOCKS_ODV , "number of blocks for computation of psd" );
236  m_parser->registerOption(m_option_psd_hopSizeRatio, UQ_SEQUENCE_PSD_HOP_SIZE_RATIO_ODV , "hop size ratio for psd" );
237  m_parser->registerOption(m_option_psd_paramId, UQ_SEQUENCE_PSD_PARAM_ID_ODV , "parameter id for psd computations" );
238  m_parser->registerOption(m_option_psd_write, UQ_SEQUENCE_PSD_WRITE_ODV , "write psd" );
239  m_parser->registerOption(m_option_psdAtZero_compute, UQ_SEQUENCE_PSD_AT_ZERO_COMPUTE_ODV, "compute power spectral densities" );
240  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" );
241  m_parser->registerOption(m_option_psdAtZero_hopSizeRatio, UQ_SEQUENCE_PSD_AT_ZERO_HOP_SIZE_RATIO_ODV , "hop size ratio for psd at zero" );
242  m_parser->registerOption(m_option_psdAtZero_display, UQ_SEQUENCE_PSD_AT_ZERO_DISPLAY_ODV, "display computed psd at frequency zero on screen" );
243  m_parser->registerOption(m_option_psdAtZero_write, UQ_SEQUENCE_PSD_AT_ZERO_WRITE_ODV , "write computed psd at frequency zero to the output file" );
244  m_parser->registerOption(m_option_geweke_compute, UQ_SEQUENCE_GEWEKE_COMPUTE_ODV , "compute Geweke coefficients" );
245  m_parser->registerOption(m_option_geweke_naRatio, UQ_SEQUENCE_GEWEKE_NA_RATIO_ODV , "ratio NA for Geweke" );
246  m_parser->registerOption(m_option_geweke_nbRatio, UQ_SEQUENCE_GEWEKE_NB_RATIO_ODV , "ratio NB for Geweke" );
247  m_parser->registerOption(m_option_geweke_display, UQ_SEQUENCE_GEWEKE_DISPLAY_ODV , "display computed Geweke on screen" );
248  m_parser->registerOption(m_option_geweke_write, UQ_SEQUENCE_GEWEKE_WRITE_ODV , "write computed Geweke to the output file" );
249  m_parser->registerOption(m_option_meanStacc_compute, UQ_SEQUENCE_MEAN_STACC_COMPUTE_ODV , "compute statistical accuracy of mean" );
250  m_parser->registerOption(m_option_hist_compute, UQ_SEQUENCE_HIST_COMPUTE_ODV , "compute histograms" );
251  m_parser->registerOption(m_option_hist_numInternalBins, UQ_SEQUENCE_HIST_NUM_INTERNAL_BINS_ODV , "number of internal bins" );
252  m_parser->registerOption(m_option_cdfStacc_compute, UQ_SEQUENCE_CDF_STACC_COMPUTE_ODV , "compute statisical accuracy of cdf" );
253  m_parser->registerOption(m_option_cdfStacc_numEvalPositions, UQ_SEQUENCE_CDF_STACC_NUM_EVAL_POSITIONS_ODV , "number of evaluations points for statistical accuracy of cdf" );
254 #endif
255  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" )
256  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" )
257  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" )
258  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" )
259  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" )
260  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" )
261  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" )
262  m_parser->registerOption(m_option_kde_compute, boost::program_options::value<bool >()->default_value(UQ_SEQUENCE_KDE_COMPUTE_ODV ), "compute kernel density estimators" )
263  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" )
264  m_parser->registerOption(m_option_covMatrix_compute, boost::program_options::value<bool >()->default_value(UQ_SEQUENCE_COV_MATRIX_COMPUTE_ODV ), "compute covariance matrix" )
265  m_parser->registerOption(m_option_corrMatrix_compute, boost::program_options::value<bool >()->default_value(UQ_SEQUENCE_CORR_MATRIX_COMPUTE_ODV ), "compute correlation matrix" )
266 }
BoostInputOptionsParser * m_parser
std::string m_option_autoCorr_computeViaFft
std::string m_option_kde_numEvalPositions
std::string m_option_fft_testInversion
std::string m_option_cdfStacc_numEvalPositions
std::string m_option_psdAtZero_compute
std::string m_option_initialDiscardedPortions
std::vector< unsigned int > m_bmmLengths
std::string m_option_meanStacc_compute
std::string m_option_psdAtZero_hopSizeRatio
unsigned int m_cdfStaccNumEvalPositions
std::string m_option_psdAtZero_numBlocks
bool m_corrMatrixCompute
Whether or not compute correlation matrix.
std::vector< double > m_initialDiscardedPortions
Stores the initial discarded portion of the chain.
std::string m_option_hist_numInternalBins
std::string m_option_psdAtZero_display
std::string m_option_mean_monitorPeriod
std::vector< unsigned int > m_psdAtZeroNumBlocks
std::string m_option_autoCorr_computeViaDef
unsigned int m_kdeNumEvalPositions
Number of positions to evaluate kde.
unsigned int m_autoCorrLagSpacing
Lag spacing of the autocorrelation.
bool m_covMatrixCompute
Whether or not compute covariance matrix.
bool m_kdeCompute
Whether or not compute kernel density estimate (kde).
bool m_autoCorrWrite
Whether or not write autocorrelation to file.
bool m_autoCorrDisplay
Whether or not display autocorrelation.
unsigned int m_autoCorrSecondLag
Second lag of the autocorrelation.
bool m_autoCorrComputeViaDef
Whether or not compute autocorrelation via definition.
std::string m_option_covMatrix_compute
unsigned int m_autoCorrNumLags
Number of lags of the autocorrelation.
bool m_autoCorrComputeViaFft
Whether or not compute autocorrelation via FFT.
std::string m_option_autoCorr_secondLag
std::string m_option_corrMatrix_compute
std::string m_option_autoCorr_lagSpacing
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().

273 {
274  this->copy(src);
275 }
void copy(const SsOptionsValues &src)
Copies the option values from src to this.
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().

559 {
561 #ifdef QUESO_COMPUTES_EXTRA_POST_PROCESSING_STATISTICS
563  m_bmmRun = src.m_bmmRun;
567  m_fftSize = src.m_fftSize;
569  m_fftWrite = src.m_fftWrite;
574  m_psdWrite = src.m_psdWrite;
590 #endif
602 
603  return;
604 }
std::vector< unsigned int > m_bmmLengths
unsigned int m_cdfStaccNumEvalPositions
bool m_corrMatrixCompute
Whether or not compute correlation matrix.
std::vector< double > m_initialDiscardedPortions
Stores the initial discarded portion of the chain.
std::vector< unsigned int > m_psdAtZeroNumBlocks
unsigned int m_kdeNumEvalPositions
Number of positions to evaluate kde.
unsigned int m_autoCorrLagSpacing
Lag spacing of the autocorrelation.
bool m_covMatrixCompute
Whether or not compute covariance matrix.
bool m_kdeCompute
Whether or not compute kernel density estimate (kde).
bool m_autoCorrWrite
Whether or not write autocorrelation to file.
bool m_autoCorrDisplay
Whether or not display autocorrelation.
unsigned int m_autoCorrSecondLag
Second lag of the autocorrelation.
bool m_autoCorrComputeViaDef
Whether or not compute autocorrelation via definition.
unsigned int m_autoCorrNumLags
Number of lags of the autocorrelation.
bool m_autoCorrComputeViaFft
Whether or not compute autocorrelation via FFT.
SsOptionsValues & SsOptionsValues::operator= ( const SsOptionsValues rhs)

Assignment operator; it copies rhs to this.

Definition at line 278 of file SequenceStatisticalOptions.C.

References copy().

279 {
280  this->copy(rhs);
281  return *this;
282 }
void copy(const SsOptionsValues &src)
Copies the option values from src to this.

Member Data Documentation

bool SsOptionsValues::m_autoCorrComputeViaDef
bool SsOptionsValues::m_autoCorrComputeViaFft
bool SsOptionsValues::m_autoCorrDisplay
unsigned int SsOptionsValues::m_autoCorrLagSpacing
unsigned int SsOptionsValues::m_autoCorrNumLags
unsigned int SsOptionsValues::m_autoCorrSecondLag
bool SsOptionsValues::m_autoCorrWrite
bool SsOptionsValues::m_bmmDisplay
std::vector<unsigned int> SsOptionsValues::m_bmmLengths
bool SsOptionsValues::m_bmmWrite

Definition at line 168 of file SequenceStatisticalOptions.h.

Referenced by SequenceStatisticalOptions::bmmWrite().

bool SsOptionsValues::m_corrMatrixCompute
bool SsOptionsValues::m_covMatrixCompute
std::vector<double> SsOptionsValues::m_initialDiscardedPortions
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
std::string SsOptionsValues::m_option_autoCorr_computeViaDef
private

Definition at line 210 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_autoCorr_computeViaFft
private

Definition at line 211 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_autoCorr_display
private

Definition at line 215 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_autoCorr_lagSpacing
private

Definition at line 213 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_autoCorr_numLags
private

Definition at line 214 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_autoCorr_secondLag
private

Definition at line 212 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_autoCorr_write
private

Definition at line 216 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_bmm_display
private

Definition at line 226 of file SequenceStatisticalOptions.h.

std::string SsOptionsValues::m_option_bmm_lengths
private

Definition at line 225 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_bmm_run
private

Definition at line 224 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_bmm_write
private

Definition at line 227 of file SequenceStatisticalOptions.h.

std::string SsOptionsValues::m_option_cdfStacc_compute
private

Definition at line 251 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_cdfStacc_numEvalPositions
private

Definition at line 252 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_corrMatrix_compute
private

Definition at line 220 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_covMatrix_compute
private

Definition at line 219 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_fft_compute
private

Definition at line 228 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_fft_paramId
private

Definition at line 229 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_fft_size
private

Definition at line 230 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_fft_testInversion
private

Definition at line 231 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_fft_write
private

Definition at line 232 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_geweke_compute
private

Definition at line 243 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_geweke_display
private

Definition at line 246 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_geweke_naRatio
private

Definition at line 244 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_geweke_nbRatio
private

Definition at line 245 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_geweke_write
private

Definition at line 247 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_help
private

Definition at line 207 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_hist_compute
private

Definition at line 249 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_hist_numInternalBins
private

Definition at line 250 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_initialDiscardedPortions
private

Definition at line 208 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_kde_compute
private

Definition at line 217 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_kde_numEvalPositions
private

Definition at line 218 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_mean_monitorPeriod
private

Definition at line 223 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_meanStacc_compute
private

Definition at line 248 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_psd_compute
private

Definition at line 233 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_psd_hopSizeRatio
private

Definition at line 235 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_psd_numBlocks
private

Definition at line 234 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_psd_paramId
private

Definition at line 236 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_psd_write
private

Definition at line 237 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_psdAtZero_compute
private

Definition at line 238 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_psdAtZero_display
private

Definition at line 241 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_psdAtZero_hopSizeRatio
private

Definition at line 240 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_psdAtZero_numBlocks
private

Definition at line 239 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_option_psdAtZero_write
private

Definition at line 242 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

BoostInputOptionsParser* SsOptionsValues::m_parser
private

Definition at line 205 of file SequenceStatisticalOptions.h.

Referenced by SsOptionsValues().

std::string SsOptionsValues::m_prefix

Definition at line 124 of file SequenceStatisticalOptions.h.

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

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

Generated on Tue Jun 5 2018 19:48:57 for queso-0.57.1 by  doxygen 1.8.5