This class provides options for a Statistical Inverse Problem if no input file is available. More...

#include <StatisticalInverseProblemOptions.h>

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

	SipOptionsValues (const BaseEnvironment env, const char prefix)

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

virtual	~SipOptionsValues ()
	Destructor. More...

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

Public Attributes
std::string	m_prefix

std::string	m_help
	If this string is non-empty, options are print to the output file. More...

bool	m_computeSolution

std::string	m_dataOutputFileName

std::set< unsigned int >	m_dataOutputAllowedSet

std::string	m_solverString

bool	m_seedWithMAPEstimator

bool	m_useOptimizerMonitor

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

void	checkOptions ()

Private Attributes
ScopedPtr < BoostInputOptionsParser > ::Type	m_parser

std::string	m_option_help

std::string	m_option_computeSolution

std::string	m_option_dataOutputFileName

std::string	m_option_dataOutputAllowedSet

std::string	m_option_solver

std::string	m_option_seedWithMAPEstimator

std::string	m_option_useOptimizerMonitor

Friends
std::ostream &	operator<< (std::ostream &os, const SipOptionsValues &obj)

Detailed Description

This class provides options for a Statistical Inverse Problem if no input file is available.

In order to solve a Statistical Inverse Problem (SIP), QUESO expects some options for its methods to be fully defined. This class provides default values for such options if no input file is available.

Definition at line 75 of file StatisticalInverseProblemOptions.h.

Constructor & Destructor Documentation

QUESO::SipOptionsValues::SipOptionsValues ( )

Default constructor.

Assigns the default suite of options to the Statistical Inverse Problem.

Definition at line 43 of file StatisticalInverseProblemOptions.C.

   :
   m_prefix("ip_"),
   m_help(UQ_SIP_HELP),
   m_computeSolution     (UQ_SIP_COMPUTE_SOLUTION_ODV     ),
   m_dataOutputFileName  (UQ_SIP_DATA_OUTPUT_FILE_NAME_ODV),
   m_seedWithMAPEstimator(UQ_SIP_SEEDWITHMAPESTIMATOR),
   m_useOptimizerMonitor(UQ_SIP_USEOPTIMIZERMONITOR),
 //m_dataOutputAllowedSet(),
 #ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
   m_parser(),
 #endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
   m_option_help                (m_prefix + "help"                ),
   m_option_computeSolution     (m_prefix + "computeSolution"     ),
   m_option_dataOutputFileName  (m_prefix + "dataOutputFileName"  ),
   m_option_dataOutputAllowedSet(m_prefix + "dataOutputAllowedSet"),
 #ifdef UQ_SIP_READS_SOLVER_OPTION
   m_option_solver              (m_prefix + "solver"              ),
   m_solverString        (UQ_SIP_SOLVER_ODV)
 #endif
   m_option_seedWithMAPEstimator(m_prefix + "seedWithMAPEstimator"),
   m_option_useOptimizerMonitor(m_prefix + "useOptimizerMonitor")
 {
 }

QUESO::SipOptionsValues::SipOptionsValues	(	const BaseEnvironment *	env,
		const char *	prefix
	)

Definition at line 68 of file StatisticalInverseProblemOptions.C.

References checkOptions(), QUESO::BaseEnvironment::input(), m_computeSolution, m_dataOutputAllowedSet, m_dataOutputFileName, m_help, m_option_computeSolution, m_option_dataOutputAllowedSet, m_option_dataOutputFileName, m_option_help, m_option_seedWithMAPEstimator, m_option_solver, m_option_useOptimizerMonitor, m_parser, m_seedWithMAPEstimator, QUESO::m_solver, m_useOptimizerMonitor, and QUESO::size.

   :
   m_prefix((std::string)(prefix) + "ip_"),
   m_help(UQ_SIP_HELP),
   m_computeSolution     (UQ_SIP_COMPUTE_SOLUTION_ODV     ),
   m_dataOutputFileName  (UQ_SIP_DATA_OUTPUT_FILE_NAME_ODV),
   m_seedWithMAPEstimator(UQ_SIP_SEEDWITHMAPESTIMATOR),
   m_useOptimizerMonitor(UQ_SIP_USEOPTIMIZERMONITOR),
 //m_dataOutputAllowedSet(),
 #ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
   m_parser(new BoostInputOptionsParser(env->optionsInputFileName())),
 #endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
   m_option_help                (m_prefix + "help"                ),
   m_option_computeSolution     (m_prefix + "computeSolution"     ),
   m_option_dataOutputFileName  (m_prefix + "dataOutputFileName"  ),
   m_option_dataOutputAllowedSet(m_prefix + "dataOutputAllowedSet"),
 #ifdef UQ_SIP_READS_SOLVER_OPTION
   m_option_solver              (m_prefix + "solver"              ),
   m_solverString        (UQ_SIP_SOLVER_ODV)
 #endif
   m_option_seedWithMAPEstimator(m_prefix + "seedWithMAPEstimator"),
   m_option_useOptimizerMonitor(m_prefix + "useOptimizerMonitor")
 {
 #ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
   m_parser->registerOption<std::string>(m_option_help, UQ_SIP_HELP, "produce help message for statistical inverse problem");
   m_parser->registerOption<bool       >(m_option_computeSolution,      UQ_SIP_COMPUTE_SOLUTION_ODV       , "compute solution process"                            );
   m_parser->registerOption<std::string>(m_option_dataOutputFileName,   UQ_SIP_DATA_OUTPUT_FILE_NAME_ODV  , "name of data output file"                            );
   m_parser->registerOption<std::string>(m_option_dataOutputAllowedSet, UQ_SIP_DATA_OUTPUT_ALLOWED_SET_ODV, "subEnvs that will write to data output file"         );
 #ifdef UQ_SIP_READS_SOLVER_OPTION
   m_parser->registerOption<std::string>(m_option_solver,               UQ_SIP_SOLVER_ODV                 , "algorithm for calibration"                           );
 #endif
   m_parser->registerOption<bool       >(m_option_seedWithMAPEstimator, UQ_SIP_SEEDWITHMAPESTIMATOR       , "toggle for seeding chain at MAP"                     );
   m_parser->registerOption<bool       >(m_option_useOptimizerMonitor,  UQ_SIP_USEOPTIMIZERMONITOR        , "toggle for using optimizer monitor (prints diagnostics");
 
   m_parser->scanInputFile();
 
   m_parser->getOption<std::string>(m_option_help, m_help);
   m_parser->getOption<bool       >(m_option_computeSolution,      m_computeSolution);
   m_parser->getOption<std::string>(m_option_dataOutputFileName,   m_dataOutputFileName);
   m_parser->getOption<std::set<unsigned int> >(m_option_dataOutputAllowedSet, m_dataOutputAllowedSet);
 #ifdef UQ_SIP_READS_SOLVER_OPTION
   m_parser->getOption<std::string>(m_option_solver,               m_solver);
 #endif
   m_parser->getOption<bool       >(m_option_seedWithMAPEstimator, m_seedWithMAPEstimator);
   m_parser->getOption<bool       >(m_option_useOptimizerMonitor,  m_useOptimizerMonitor);
 #else
   m_help = env->input()(m_option_help, UQ_SIP_HELP);
   m_computeSolution = env->input()(m_option_computeSolution, UQ_SIP_COMPUTE_SOLUTION_ODV);
   m_dataOutputFileName = env->input()(m_option_dataOutputFileName, UQ_SIP_DATA_OUTPUT_FILE_NAME_ODV);
 
   // UQ_SIP_DATA_OUTPUT_ALLOWED_SET_ODV is the empty set (string) by default
   unsigned int size = env->input().vector_variable_size(m_option_dataOutputAllowedSet);
   for (unsigned int i = 0; i < size; i++) {
     // We default to empty set, so the default values are actually never
     // used here
     unsigned int allowed = env->input()(m_option_dataOutputAllowedSet, i, i);
     m_dataOutputAllowedSet.insert(allowed);
   }
 
 #ifdef UQ_SIP_READS_SOLVER_OPTION
   m_solver = env->input()(m_option_solver, UQ_SIP_SOLVER_ODV);
 #endif
   m_seedWithMAPEstimator = env->input()(m_option_seedWithMAPEstimator, UQ_SIP_SEEDWITHMAPESTIMATOR);
   m_useOptimizerMonitor = env->input()(m_option_useOptimizerMonitor,  UQ_SIP_USEOPTIMIZERMONITOR);
 #endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
 
   checkOptions();
 }

QUESO::SipOptionsValues::SipOptionsValues ( const SipOptionsValues & src )

Copy constructor.

It assigns the same options values from src to this.

Definition at line 138 of file StatisticalInverseProblemOptions.C.

References copy().

 {
   this->copy(src);
 }

QUESO::SipOptionsValues::~SipOptionsValues ( )

virtual

Destructor.

Definition at line 143 of file StatisticalInverseProblemOptions.C.

144 {

145 }

Member Function Documentation

void QUESO::SipOptionsValues::checkOptions ( )

private

Definition at line 156 of file StatisticalInverseProblemOptions.C.

Referenced by SipOptionsValues().

 {
   // Nothing
 }

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

private

Copies the option values from src to this.

Definition at line 162 of file StatisticalInverseProblemOptions.C.

References m_computeSolution, m_dataOutputAllowedSet, m_dataOutputFileName, m_seedWithMAPEstimator, m_solverString, and m_useOptimizerMonitor.

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

 {
   m_computeSolution      = src.m_computeSolution;
   m_dataOutputFileName   = src.m_dataOutputFileName;
   m_dataOutputAllowedSet = src.m_dataOutputAllowedSet;
 #ifdef UQ_SIP_READS_SOLVER_OPTION
   m_solverString         = src.m_solverString;
 #endif
   m_seedWithMAPEstimator = src.m_seedWithMAPEstimator;
   m_useOptimizerMonitor = src.m_useOptimizerMonitor;
 }

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

Assignment operator; it copies rhs to this.

Definition at line 149 of file StatisticalInverseProblemOptions.C.

References copy().

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

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const SipOptionsValues &	obj
	)

friend

Definition at line 175 of file StatisticalInverseProblemOptions.C.

 {
   os << "\n" << obj.m_option_computeSolution      << " = " << obj.m_computeSolution
      << "\n" << obj.m_option_dataOutputFileName   << " = " << obj.m_dataOutputFileName;
   os << "\n" << obj.m_option_dataOutputAllowedSet << " = ";
   for (std::set<unsigned int>::iterator setIt = obj.m_dataOutputAllowedSet.begin(); setIt != obj.m_dataOutputAllowedSet.end(); ++setIt) {
     os << *setIt << " ";
   }
 #ifdef UQ_SIP_READS_SOLVER_OPTION
      << "\n" << obj.m_option_solver << " = " << obj.m_solverString
 #endif
   os << std::endl;
   return os;
 }