StatisticalInverseProblemOptions.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// QUESO - a library to support the Quantification of Uncertainty
// for Estimation, Simulation and Optimization
//
// Copyright (C) 2008-2017 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#include <queso/config_queso.h>
#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
#include <queso/BoostInputOptionsParser.h>
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS

#include <queso/Environment.h>

#ifndef UQ_SIP_OPTIONS_H
#define UQ_SIP_OPTIONS_H

#undef UQ_SIP_READS_SOLVER_OPTION

#define UQ_SIP_HELP ""
#define UQ_SIP_FILENAME_FOR_NO_FILE "."

// _ODV = option default value
#define UQ_SIP_COMPUTE_SOLUTION_ODV        1
#define UQ_SIP_DATA_OUTPUT_FILE_NAME_ODV   UQ_SIP_FILENAME_FOR_NO_FILE
#define UQ_SIP_DATA_OUTPUT_ALLOWED_SET_ODV ""
#ifdef UQ_SIP_READS_SOLVER_OPTION
#define UQ_SIP_SOLVER_ODV                  "bayes_mc" // Bayesian formula + Metropolis-Hastings
#endif

#define UQ_SIP_SEEDWITHMAPESTIMATOR 0
#define UQ_SIP_USEOPTIMIZERMONITOR 1

#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
namespace boost {
  namespace program_options {
    class options_description;
  }
}
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS

namespace QUESO {

class SipOptionsValues
{
public:


  SipOptionsValues            ();
  SipOptionsValues(const BaseEnvironment * env, const char * prefix);


  SipOptionsValues            (const SipOptionsValues& src);

  virtual ~SipOptionsValues            ();


  SipOptionsValues& operator= (const SipOptionsValues& rhs);

  std::string m_prefix;

  std::string m_help;

  bool                   m_computeSolution;
  std::string            m_dataOutputFileName;
  std::set<unsigned int> m_dataOutputAllowedSet;
#ifdef UQ_SIP_READS_SOLVER_OPTION
  std::string            m_solverString;
#endif

  bool m_seedWithMAPEstimator;
  bool m_useOptimizerMonitor;

private:
#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
  ScopedPtr<BoostInputOptionsParser>::Type m_parser;
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS

  // The input options as strings so we can parse the input file later
  std::string                   m_option_help;
  std::string                   m_option_computeSolution;
  std::string                   m_option_dataOutputFileName;
  std::string                   m_option_dataOutputAllowedSet;
#ifdef UQ_SIP_READS_SOLVER_OPTION
  std::string                   m_option_solver;
#endif
  std::string m_option_seedWithMAPEstimator;
  std::string m_option_useOptimizerMonitor;

  void copy(const SipOptionsValues& src);

  void checkOptions();

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

class StatisticalInverseProblemOptions
{
public:

  StatisticalInverseProblemOptions(const BaseEnvironment& env, const char* prefix);


  StatisticalInverseProblemOptions(const BaseEnvironment& env, const char* prefix, const SipOptionsValues& alternativeOptionsValues);

  ~StatisticalInverseProblemOptions();


  void scanOptionsValues();

  void print            (std::ostream& os) const;

  SipOptionsValues       m_ov;
  std::string                   m_prefix;

private:
#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
  void   defineMyOptions  (boost::program_options::options_description& optionsDesc) const;
  void   getMyOptionValues(boost::program_options::options_description& optionsDesc);
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS

  const BaseEnvironment& m_env;

#ifndef QUESO_DISABLE_BOOST_PROGRAM_OPTIONS
  ScopedPtr<boost::program_options::options_description>::Type m_optionsDesc;
#endif  // QUESO_DISABLE_BOOST_PROGRAM_OPTIONS

  std::string                   m_option_help;
  std::string                   m_option_computeSolution;
  std::string                   m_option_dataOutputFileName;
  std::string                   m_option_dataOutputAllowedSet;
#ifdef UQ_SIP_READS_SOLVER_OPTION
  std::string                   m_option_solver;
#endif
  std::string m_option_seedWithMAPEstimator;
  std::string m_option_useOptimizerMonitor;
};

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

}  // End namespace QUESO

#endif // UQ_SIP_OPTIONS_H