This class defines the options that specify the behaviour of the MCMC sampler. More...

#include <InfiniteDimensionalMCMCSamplerOptions.h>

Collaboration diagram for QUESO::InfiniteDimensionalMCMCSamplerOptions:

Public Member Functions
	InfiniteDimensionalMCMCSamplerOptions (const BaseEnvironment &env, const char *prefix)
	Given prefix, read the input file for parameters named prefix_*. More...

	~InfiniteDimensionalMCMCSamplerOptions ()
	Destructor. More...

void	scanOptionsValues ()
	Scans the input file for options prefixed with `prefix`. More...

void	print (std::ostream &os) const
	Prints `this` to `os`. More...

const BaseEnvironment &	env () const
	Returns the QUESO environment. More...

Public Attributes
std::string	m_prefix
	The prefix to look for in the input file. More...

std::string	m_dataOutputDirName
	Name of the output dir to save infinite dimensional output files to. More...

std::string	m_dataOutputFileName
	Name of the HDF5 output file to store chain statistics. More...

unsigned int	m_num_iters
	The total number of iterations to do. More...

unsigned int	m_save_freq
	The frequency at which to save the state of the chain. More...

double	m_rwmh_step
	The proposal step size. More...

Private Member Functions
void	defineMyOptions (po::options_description &optionsDesc) const

void	getMyOptionValues (po::options_description &optionsDesc)

Private Attributes
const BaseEnvironment &	m_env

po::options_description *	m_optionsDesc

std::string	m_option_help

std::string	m_option_dataOutputDirName

std::string	m_option_dataOutputFileName

std::string	m_option_num_iters

std::string	m_option_save_freq

std::string	m_option_rwmh_step

Detailed Description

This class defines the options that specify the behaviour of the MCMC sampler.

Definition at line 39 of file InfiniteDimensionalMCMCSamplerOptions.h.

Constructor & Destructor Documentation

QUESO::InfiniteDimensionalMCMCSamplerOptions::InfiniteDimensionalMCMCSamplerOptions	(	const BaseEnvironment &	env,
		const char *	prefix
	)

Given prefix, read the input file for parameters named prefix_*.

Definition at line 35 of file InfiniteDimensionalMCMCSamplerOptions.C.

References m_env, QUESO::BaseEnvironment::optionsInputFileName(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().

   : m_prefix((std::string)(prefix) + "infmcmc_"),
     m_env(env),
     m_optionsDesc(new po::options_description("Infinite Dimensional MCMC Sampler options")),
     m_option_help(m_prefix + "help"),
     m_option_dataOutputDirName(m_prefix + "dataOutputDirName"),
     m_option_dataOutputFileName(m_prefix + "dataOutputFileName"),
     m_option_num_iters(m_prefix + "num_iters"),
     m_option_save_freq(m_prefix + "save_freq"),
     m_option_rwmh_step(m_prefix + "rwmh_step")
 {
   UQ_FATAL_TEST_MACRO(m_env.optionsInputFileName() == "",
       m_env.worldRank(),
       "InfiniteDimensionalMCMCSamplerOptions::constructor(1)",
       "this constructor is incompatible with the abscense of an options input file");
 }

QUESO::InfiniteDimensionalMCMCSamplerOptions::~InfiniteDimensionalMCMCSamplerOptions ( )

Destructor.

Definition at line 54 of file InfiniteDimensionalMCMCSamplerOptions.C.

References m_optionsDesc.

 {
   if (m_optionsDesc) {
     delete m_optionsDesc;
   }
 } 

Member Function Documentation

void QUESO::InfiniteDimensionalMCMCSamplerOptions::defineMyOptions ( po::options_description & optionsDesc ) const

private

Definition at line 82 of file InfiniteDimensionalMCMCSamplerOptions.C.

References m_option_dataOutputDirName, m_option_dataOutputFileName, m_option_help, m_option_num_iters, m_option_rwmh_step, m_option_save_freq, UQ_INF_DATA_OUTPUT_DIR_NAME_ODV, UQ_INF_DATA_OUTPUT_FILE_NAME_ODV, UQ_INF_NUM_ITERS_ODV, UQ_INF_RWMH_STEP_ODV, and UQ_INF_SAVE_FREQ_ODV.

Referenced by scanOptionsValues().

 {
   optionsDesc.add_options()
     (m_option_help.c_str(), "produce help message for infinite dimensional sampler")
     (m_option_dataOutputDirName.c_str(), po::value<std::string>()->default_value(UQ_INF_DATA_OUTPUT_DIR_NAME_ODV), "name of data output dir")
     (m_option_dataOutputFileName.c_str(), po::value<std::string>()->default_value(UQ_INF_DATA_OUTPUT_FILE_NAME_ODV), "name of data output file (HDF5)")
     (m_option_num_iters.c_str(), po::value<int>()->default_value(UQ_INF_NUM_ITERS_ODV), "number of mcmc iterations to do")
     (m_option_save_freq.c_str(), po::value<int>()->default_value(UQ_INF_SAVE_FREQ_ODV), "the frequency at which to save the chain state")
     (m_option_rwmh_step.c_str(), po::value<double>()->default_value(UQ_INF_RWMH_STEP_ODV), "the step-size in the random-walk Metropolis proposal");
   return;
 }

const BaseEnvironment & QUESO::InfiniteDimensionalMCMCSamplerOptions::env ( ) const

Returns the QUESO environment.

Definition at line 147 of file InfiniteDimensionalMCMCSamplerOptions.C.

References m_env.

 {
   return this->m_env;
 }

void QUESO::InfiniteDimensionalMCMCSamplerOptions::getMyOptionValues ( po::options_description & optionsDesc )

private

Definition at line 95 of file InfiniteDimensionalMCMCSamplerOptions.C.

References QUESO::BaseEnvironment::allOptionsMap(), m_dataOutputDirName, m_dataOutputFileName, m_env, m_num_iters, m_option_dataOutputDirName, m_option_dataOutputFileName, m_option_help, m_option_num_iters, m_option_rwmh_step, m_option_save_freq, m_rwmh_step, m_save_freq, and QUESO::BaseEnvironment::subDisplayFile().

Referenced by scanOptionsValues().

 {
   if (m_env.allOptionsMap().count(m_option_help)) {
     if (m_env.subDisplayFile()) {
       *m_env.subDisplayFile() << optionsDesc
                               << std::endl;
     }
   }
 
   if (m_env.allOptionsMap().count(m_option_dataOutputDirName)) {
     this->m_dataOutputDirName = ((const po::variable_value&) m_env.allOptionsMap()[m_option_dataOutputDirName]).as<std::string>();
   }
 
   if (m_env.allOptionsMap().count(m_option_dataOutputFileName)) {
     this->m_dataOutputFileName = ((const po::variable_value&) m_env.allOptionsMap()[m_option_dataOutputFileName]).as<std::string>();
   }
 
   if (m_env.allOptionsMap().count(m_option_num_iters)) {
     this->m_num_iters = ((const po::variable_value&) m_env.allOptionsMap()[m_option_num_iters]).as<int>();
   }
 
   if (m_env.allOptionsMap().count(m_option_save_freq)) {
     this->m_save_freq = ((const po::variable_value&) m_env.allOptionsMap()[m_option_save_freq]).as<int>();
   }
 
   if (m_env.allOptionsMap().count(m_option_rwmh_step)) {
     this->m_rwmh_step = ((const po::variable_value&) m_env.allOptionsMap()[m_option_rwmh_step]).as<double>();
   }
 
   return;
 }

void QUESO::InfiniteDimensionalMCMCSamplerOptions::print ( std::ostream & os ) const

Prints this to os.

Definition at line 128 of file InfiniteDimensionalMCMCSamplerOptions.C.

References m_dataOutputDirName, m_dataOutputFileName, m_num_iters, m_option_dataOutputDirName, m_option_dataOutputFileName, m_option_num_iters, m_option_rwmh_step, m_option_save_freq, m_rwmh_step, and m_save_freq.

Referenced by QUESO::operator<<().

 {
   os << "\n" << this->m_option_dataOutputDirName << " = " << this->m_dataOutputDirName;
   os << "\n" << this->m_option_dataOutputFileName << " = " << this->m_dataOutputFileName;
   os << "\n" << this->m_option_num_iters << " = " << this->m_num_iters;
   os << "\n" << this->m_option_save_freq << " = " << this->m_save_freq;
   os << "\n" << this->m_option_rwmh_step << " = " << this->m_rwmh_step;
   os << std::endl;
   return;
 }

void QUESO::InfiniteDimensionalMCMCSamplerOptions::scanOptionsValues ( )

Scans the input file for options prefixed with prefix.

Definition at line 61 of file InfiniteDimensionalMCMCSamplerOptions.C.

References defineMyOptions(), getMyOptionValues(), m_env, m_optionsDesc, m_prefix, QUESO::BaseEnvironment::scanInputFileForMyOptions(), QUESO::BaseEnvironment::subDisplayFile(), UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().

 {
   UQ_FATAL_TEST_MACRO(m_optionsDesc == NULL,
                       m_env.worldRank(),
                       "InfiniteDimensionalMCMCSamplerOptions::scanOptionsValues()",
                       "m_optionsDesc variable is NULL");
 
   this->defineMyOptions(*m_optionsDesc);
   m_env.scanInputFileForMyOptions(*m_optionsDesc);
   this->getMyOptionValues(*m_optionsDesc);
 
   if (m_env.subDisplayFile() != NULL) {
     *m_env.subDisplayFile() << "In InfiniteDimensionalMCMCSamplerOptions::scanOptionsValues()"
                             << ": after reading values of options with prefix '" << m_prefix
                             << "', state of  object is:"
                             << "\n" << *this
                             << std::endl;
   }
   return;
 }

Member Data Documentation

std::string QUESO::InfiniteDimensionalMCMCSamplerOptions::m_dataOutputDirName

Name of the output dir to save infinite dimensional output files to.

For example, if m_dataOutputDirName is set to 'outputData/chain' then a series of folders will be created, one for each QUESO subenvironment, called 'outputData/chain0', 'outputData/chain1', etc. Inside these folders, output data from the infinite dimensional chain will be saved as an HDF5 file.

Definition at line 65 of file InfiniteDimensionalMCMCSamplerOptions.h.

Referenced by getMyOptionValues(), and print().

std::string QUESO::InfiniteDimensionalMCMCSamplerOptions::m_dataOutputFileName

Name of the HDF5 output file to store chain statistics.

Definition at line 68 of file InfiniteDimensionalMCMCSamplerOptions.h.

Referenced by getMyOptionValues(), and print().

const BaseEnvironment& QUESO::InfiniteDimensionalMCMCSamplerOptions::m_env

private

Definition at line 86 of file InfiniteDimensionalMCMCSamplerOptions.h.

Referenced by env(), getMyOptionValues(), InfiniteDimensionalMCMCSamplerOptions(), and scanOptionsValues().

unsigned int QUESO::InfiniteDimensionalMCMCSamplerOptions::m_num_iters

The total number of iterations to do.