Gambit::Options Class Reference

A small wrapper object for 'options' nodes. More...

#include <yaml_options.hpp>

Public Member Functions
	Options ()
	Default constructor. More...
	Options (const YAML::Node &options)
	Copy constructor. More...
	Options (YAML::Node &&options)
	Move constructor. More...
template<typename TYPE >
std::vector< TYPE >	getVector (std::string key) const
	Get a std::vector of a particular type. More...
template<typename... args>
const std::vector< str >	getNames (const args &... keys) const
	Retrieve values from key-value pairs in options node. More...
const std::vector< str >	getNames () const
	Retrieve values from all key-value pairs in options node. More...
template<typename... args>
const Options	getOptions (const args &... keys) const
	Recursive options retrieval. More...
template<typename... args>
YAML::Node	getNode (const args &... keys) const
	Retrieve raw YAML node. More...
template<typename... args>
YAML::Node	loadFromFile (const args &... keys) const
	Get YAML node from file. More...
YAML::const_iterator	begin () const
	Return begin and end of options. More...
YAML::const_iterator	end () const
template<typename... args>
bool	hasKey (const args &... keys) const
	Getters for key/value pairs (which is all the options node should contain) More...
template<typename TYPE , typename... args>
TYPE	getValue (const args &... keys) const
template<typename TYPE , typename... args>
TYPE	getValueOrDef (TYPE def, const args &... keys) const
template<typename KEYTYPE , typename VALTYPE >
void	setValue (const KEYTYPE &key, const VALTYPE &val)
	Basic setter, for adding extra options. More...

Private Attributes
YAML::Node	options

Detailed Description

A small wrapper object for 'options' nodes.

These can be extracted from the prior, observable/likelihood and rules sections of the inifile, or set by hand in module standalone mode.

Definition at line 50 of file yaml_options.hpp.

Constructor & Destructor Documentation

Options() [1/3]

Gambit::Options::Options ( )

inline

Default constructor.

Definition at line 56 of file yaml_options.hpp.

Referenced by getOptions().

{}

Here is the caller graph for this function:

Options() [2/3]

Gambit::Options::Options ( const YAML::Node &  options )

inline

Copy constructor.

Definition at line 59 of file yaml_options.hpp.

: options(options) {}

Options() [3/3]

Gambit::Options::Options ( YAML::Node &&  options )

inline

Move constructor.

Definition at line 62 of file yaml_options.hpp.

: options(std::move(options)) {}

Member Function Documentation

begin()

YAML::const_iterator Gambit::Options::begin ( ) const

inline

Return begin and end of options.

Definition at line 239 of file yaml_options.hpp.

References options.

{ return options.begin(); }

end()

YAML::const_iterator Gambit::Options::end ( ) const

inline

Definition at line 240 of file yaml_options.hpp.

References options.

Referenced by getNames().

{ return options.end(); }

Here is the caller graph for this function:

getNames() [1/2]

template<typename... args>

const std::vector<str> Gambit::Options::getNames ( const args &...  keys ) const

inline

Retrieve values from key-value pairs in options node.

Works for an arbitrary set of input keys (of any type), and returns all values as strings.

Definition at line 165 of file yaml_options.hpp.

References end(), Gambit::getVariadicNode(), and options.

Referenced by Gambit::Priors::CompositePrior::CompositePrior(), and Gambit::SpecBit::run_FS_spectrum_generator().

      {
        std::vector<str> result;
        const YAML::Node node = getVariadicNode(options, keys...);

        if (node.IsMap())
        {
          for (auto it = node.begin(), end = node.end(); it != end; ++it)
          {
            result.push_back( it->first.as<str>() );
          }
        }

        return result;
      }

Here is the call graph for this function:

Here is the caller graph for this function:

getNames() [2/2]

const std::vector<str> Gambit::Options::getNames ( ) const

inline

Retrieve values from all key-value pairs in options node.

Returns all keys as strings.

Definition at line 183 of file yaml_options.hpp.

References end(), and options.

      {
        std::vector<str> result;

        for (auto it = options.begin(), end = options.end(); it != end; ++it)
        {
          result.push_back( it->first.as<str>() );
        }

        return result;
      }

Here is the call graph for this function:

getNode()

template<typename... args>

YAML::Node Gambit::Options::getNode ( const args &...  keys ) const

inline

Retrieve raw YAML node.

Definition at line 212 of file yaml_options.hpp.

References Gambit::getVariadicNode(), LOCAL_INFO, options, Gambit::stringifyVariadic(), and Gambit::utils_error().

Referenced by Gambit::Priors::CompositePrior::CompositePrior(), Gambit::Priors::FixedPrior::FixedPrior(), getVector(), Gambit::Scanner::Scan_Manager::Run(), and Gambit::Scanner::Scan_Manager::Scan_Manager().

      {
        const YAML::Node node = getVariadicNode(options, keys...);
        if (not node)
        {
          std::ostringstream os;
          os << "No options entry for [" << stringifyVariadic(keys...) << "]\n Node contents:  " << options;
          utils_error().raise(LOCAL_INFO,os.str());
        }
        return node;
      }

Here is the call graph for this function:

Here is the caller graph for this function:

getOptions()

template<typename... args>

const Options Gambit::Options::getOptions ( const args &...  keys ) const

inline

Recursive options retrieval.

Definition at line 197 of file yaml_options.hpp.

References Gambit::getVariadicNode(), Options(), and options.

Referenced by Gambit::Priors::CompositePrior::CompositePrior().

      {
        const YAML::Node node = getVariadicNode(options, keys...);
        if (node["options"])
        {
          return Options(node["options"]);
        }
        else
        {
          return Options(node);
        }
      }

Here is the call graph for this function:

Here is the caller graph for this function:

getValue()

template<typename TYPE , typename... args>

TYPE Gambit::Options::getValue ( const args &...  keys ) const

inline

Definition at line 73 of file yaml_options.hpp.

References Gambit::getVariadicNode(), LOCAL_INFO, options, Gambit::stringifyVariadic(), and Gambit::utils_error().

Referenced by Gambit::Priors::Cauchy::Cauchy(), Gambit::Printers::asciiPrinter::common_constructor(), Gambit::Printers::HDF5Printer::common_constructor(), Gambit::Priors::CompositePrior::CompositePrior(), Gambit::Priors::DoubleLogFlatJoin::DoubleLogFlatJoin(), Gambit::Priors::FixedPrior::FixedPrior(), Gambit::Priors::Gaussian::Gaussian(), Gambit::Printers::HDF5Printer2::get_filename(), Gambit::Priors::DoubleLogFlatJoin::get_option(), Gambit::ColliderBit::getBuckFast(), Gambit::ColliderBit::getColliderPythia(), Gambit::Printers::HDF5Printer2::HDF5Printer2(), Gambit::Scanner::Plugins::pluginInfo::iniFile(), Gambit::Priors::LogNormal::LogNormal(), Gambit::Priors::MultiPriors::MultiPriors(), Gambit::Printers::PrinterManager::new_stream(), Gambit::Printers::nonePrinter::nonePrinter(), Gambit::functor::notifyOfSubCaps(), Gambit::ColliderBit::operateLHCLoop(), Gambit::Priors::Plugin::Plugin(), Gambit::Priors::RangePrior1D< T >::RangePrior1D(), Gambit::SpecBit::run_FS_spectrum_generator(), Gambit::Scanner::Scan_Manager::Scan_Manager(), Gambit::Printers::SQLitePrinter::SQLitePrinter(), and Gambit::Printers::SQLiteReader::SQLiteReader().

      {
        const YAML::Node node = getVariadicNode(options, keys...);
        TYPE result;
        if (not node)
        {
          std::ostringstream os;
          os << "No options entry for [" << stringifyVariadic(keys...) << "]\n Node contents:  " << options;
          utils_error().raise(LOCAL_INFO,os.str());
          result = TYPE();
        }
        else
        {
          try
          {
            result = NodeUtility::getNode<TYPE>(node);
          }
          catch(YAML::Exception& e)
          {
            std::string nodestr;
            try
            {
              nodestr = node.as<std::string>();
            }
            catch(YAML::Exception& e)
            {
              nodestr = "<Couldn't even convert to string!>";
            }
            std::ostringstream os;
            os << "Error retrieving options entry for [" << stringifyVariadic(keys...)
               << "] as type " << typeid(TYPE).name() << " (template parameter: see below). String form of node value was: "
               << nodestr << std::endl
               << "YAML message follows: " << std::endl
               << e.what();
            utils_error().raise(LOCAL_INFO,os.str());
            result = TYPE();
          }
        }
        return result;
      }

Here is the call graph for this function:

Here is the caller graph for this function:

getValueOrDef()

template<typename TYPE , typename... args>

TYPE Gambit::Options::getValueOrDef ( TYPE  def, const args &...  keys  ) const

inline

Definition at line 115 of file yaml_options.hpp.

References Gambit::LogTags::def, Gambit::getVariadicNode(), and options.

Referenced by Gambit::SpecBit::check_perturb_MDM(), Gambit::Printers::asciiPrinter::common_constructor(), Gambit::Printers::HDF5Printer::common_constructor(), Gambit::Printers::HDF5Printer2::get_buffer_length(), Gambit::Printers::HDF5Printer2::get_groupname(), Gambit::SpecBit::get_ScalarSingletDM_Z3_spectrum(), Gambit::Printers::HDF5Printer2::get_sync(), Gambit::ColliderBit::getBuckFast(), Gambit::Printers::HDF5Printer2::HDF5Printer2(), Gambit::SpecBit::lnL_highscale_vacuum_decay_single_field(), Gambit::Printers::PrinterManager::new_reader(), Gambit::ColliderBit::operateLHCLoop(), Gambit::SpecBit::run_FS_spectrum_generator(), and Gambit::Printers::SQLitePrinter::SQLitePrinter().

      {
        const YAML::Node node = getVariadicNode(options, keys...);
        TYPE result;
        if (not node)
        {
          result = def;
        }
        else
        {
          result = getValue<TYPE>(keys...);
        }
        return result;
      }

Here is the call graph for this function:

Here is the caller graph for this function:

getVector()

template<typename TYPE >

std::vector<TYPE> Gambit::Options::getVector ( std::string  key ) const

inline

Get a std::vector of a particular type.

If the entry is a scalar rather than a vector, try to convert it to a size one std::vector

Definition at line 149 of file yaml_options.hpp.

References getNode().

Referenced by Gambit::Priors::Cauchy::Cauchy(), Gambit::Priors::Gaussian::Gaussian(), and Gambit::Priors::LogNormal::LogNormal().

      {
        if (getNode(key).IsScalar())
        {
          return {getValue<TYPE>(key)};
        } 
        else
        {
          return getValue<std::vector<TYPE>>(key);
        }
      }

Here is the call graph for this function:

Here is the caller graph for this function:

hasKey()

template<typename... args>

bool Gambit::Options::hasKey ( const args &...  keys ) const

inline

Getters for key/value pairs (which is all the options node should contain)

Definition at line 67 of file yaml_options.hpp.

References Gambit::getVariadicNode(), and options.

Referenced by Gambit::Priors::Cauchy::Cauchy(), Gambit::Printers::asciiPrinter::common_constructor(), Gambit::Printers::HDF5Printer::common_constructor(), Gambit::Priors::CompositePrior::CompositePrior(), Gambit::Priors::DoubleLogFlatJoin::DoubleLogFlatJoin(), Gambit::Priors::FixedPrior::FixedPrior(), Gambit::Priors::Gaussian::Gaussian(), Gambit::Printers::HDF5Printer2::get_filename(), Gambit::Priors::DoubleLogFlatJoin::get_option(), Gambit::ColliderBit::getBuckFast(), Gambit::ColliderBit::getColliderPythia(), Gambit::Priors::LogNormal::LogNormal(), Gambit::Priors::MultiPriors::MultiPriors(), Gambit::functor::notifyOfSubCaps(), Gambit::Priors::Plugin::Plugin(), Gambit::Priors::RangePrior1D< T >::RangePrior1D(), Gambit::Scanner::Scan_Manager::Run(), Gambit::SpecBit::run_FS_spectrum_generator(), Gambit::Scanner::Scan_Manager::Scan_Manager(), and Gambit::Printers::SQLitePrinter::SQLitePrinter().

      {
        return getVariadicNode(options, keys...);
      }

Here is the call graph for this function:

Here is the caller graph for this function:

loadFromFile()

template<typename... args>

YAML::Node Gambit::Options::loadFromFile ( const args &...  keys ) const

inline

Get YAML node from file.

Definition at line 226 of file yaml_options.hpp.

References Gambit::getVariadicNode(), LOCAL_INFO, options, Gambit::stringifyVariadic(), and Gambit::utils_error().

      {
        const YAML::Node node = getVariadicNode(options, keys...);
        if (not node)
        {
          std::ostringstream os;
          os << "No options entry for [" << stringifyVariadic(keys...) << "]\n Node contents:  " << options;
          utils_error().raise(LOCAL_INFO,os.str());
        }
        return YAML::LoadFile(node.as<std::string>().c_str());
      }

Here is the call graph for this function:

setValue()

template<typename KEYTYPE , typename VALTYPE >

void Gambit::Options::setValue ( const KEYTYPE &  key, const VALTYPE &  val  )

inline

Basic setter, for adding extra options.

Definition at line 135 of file yaml_options.hpp.

References options.

Referenced by Gambit::Printers::PrinterManager::new_stream(), Gambit::functor::notifyOfSubCaps(), Gambit::Printers::PrinterManager::PrinterManager(), Gambit::Printers::SQLitePrinter::resume_reader_options(), Gambit::Printers::HDF5Printer::resume_reader_options(), Gambit::Printers::HDF5Printer2::resume_reader_options(), and scanner_plugin().

      {
         options[key] = val;
         return;
      }

Here is the caller graph for this function:

Member Data Documentation

options

YAML::Node Gambit::Options::options

private

Definition at line 244 of file yaml_options.hpp.

Referenced by begin(), end(), getNames(), getNode(), getOptions(), getValue(), getValueOrDef(), hasKey(), loadFromFile(), and setValue().

---

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

• Utils/include/gambit/Utils/yaml_options.hpp