file Utils/model_parameters.hpp #

[No description available] More…

Namespaces #

Classes #

Detailed Description #

Author:

• Johan Lundberg (SUfit version; model_types.hpp)
• Ben Farmer
• Pat Scott

(p.scott@imperial.ac.uk)

Date:

• 2011 Jul - Aug
• 2013 May, Jun
• 2014 Aug: Went through and cut out some stuff that seemed unused: removed the old ModelParametersBase class that didn’t do much; removed the virtualisation since nothing derives from this class at the moment; incorporated the proper error handling system; put class definitions into a seperate source file.
• 2015 Aug: Added copy_parameters_from function
• 2019 Jul:
• 2013 Oct
• 2014 Jan, Nov
• 2015 Sep

Class for holding model parameters. Defines the basic container and get/set functions for the model parameters. Originally adapted from SUfit version (the connection is basically gone now though.)

Authors (add name and date if you modify):

Source code #

//   GAMBIT: Global and Modular BSM Inference Tool
//   *********************************************
///  \file
///
///  Class for holding model parameters. Defines the
///  basic container and get/set functions for
///  the model parameters. Originally adapted from
///  SUfit version (the connection is basically gone 
///  now though.)
///
///  *********************************************
///
///  Authors (add name and date if you modify):
///   
///  \author Johan Lundberg (SUfit version; model_types.hpp)
///  \date 2011 Jul - Aug
///
///  \author Ben Farmer
///  \date 2013 May, Jun 
///  \date 2014 Aug:  Went through and cut out some 
///                   stuff that seemed unused: removed
///                   the old ModelParametersBase class
///                   that didn't do much; removed the
///                   virtualisation since nothing derives
///                   from this class at the moment; 
///                   incorporated the proper error 
///                   handling system; put class 
///                   definitions into a seperate source file.
///  \date 2015 Aug:  Added copy_parameters_from function
///  \date 2019 Jul:  
///
///  \author Pat Scott  
///          (p.scott@imperial.ac.uk)
///  \date 2013 Oct
///  \date 2014 Jan, Nov
///  \date 2015 Sep
///
///  *********************************************


#ifndef __model_parameters_hpp__
#define __model_parameters_hpp__

#include <map>
#include <vector>
#include <iostream>
#include "gambit/Utils/export_symbols.hpp"

namespace Gambit {

  // Model parameter map type; used by all models
  typedef std::map<std::string, double> parameterMap;

  class EXPORT_SYMBOLS ModelParameters
  {

    protected:

      /// Checks if this model container holds a parameter match the supplied name
      void assert_contains(std::string) const;

    public:

      /// Default constructor
      ModelParameters();

      /// Constructor using vector of strings
      ModelParameters(const std::vector<std::string>&);
    
      /// Constructor using array of char arrays
      ModelParameters(const char**);
   
      /// Get value of named parameter 
      double getValue(std::string const & inkey) const;

      /// Check if a parameter exists in this object
      bool has(const std::string&) const;

      /// Get values of all parameters
      const std::map<std::string, double>& getValues() const;
   
      /// Get a const iterator to the first parameter map entry
      std::map<std::string, double>::const_iterator begin() const;

      /// Get a const iterator to the last parameter map entry
      std::map<std::string, double>::const_iterator end() const;

      /// Get number of parameters stored in this object
      int getNumberOfPars() const;

      /// Get parameter value using bracket operator
      const double & operator[](std::string const & inkey) const;

      /// Get parameter value using 'at' syntax
      const double & at(std::string const & inkey) const;

      /// Set single parameter value
      void setValue(std::string const &inkey,double const&value);
  
      /// Set many parameter values using a map
      void setValues(std::map<std::string,double> const &params_map, bool missing_is_error = true);

      /// Set many parameter values using another ModelParameters object
      void setValues(ModelParameters const& donor, bool missing_is_error = true);

      /// Get parameter keys (names), probably for external iteration
      std::vector<std::string> getKeys() const;

      /// Dump parameter names and values to stdout (should be for debugging only)
      void print() const;

      /// Dump parameter names and values to stream (again for debugging only I think)
      friend std::ostream &operator<<(std::ostream &strm, const ModelParameters &me)
      {
        strm << "ModelParameters: Printing: "<<std::endl;
        for (std::map<std::string,double>::const_iterator it=me._values.begin();it!=me._values.end();it++)
        {
          strm << "parameter: " << it->first << " value: "<<it->second ;
        }
        return strm;
      }

      /// Define a parameter with name, value (i.e. add to internal map). Value is initialised to zero
      void _definePar(const std::string &newkey);

      /// Define many new parameters at once via a vector of names
      void _definePars(const std::vector<std::string> &v);

      /// Define many new parameters at once via an array of char arrays
      void _definePars(const char** array);

      /// Getters/setters for model and output names
      std::string getModelName() const;
      std::string getOutputName() const;
      void setModelName (const std::string&);
      void setOutputName(const std::string&);
 
    private:

      /// Internal map representation of parameters and their values
      std::map<std::string,double> _values;

      /// Name of the model; intended mainly for more helpful error messages
      std::string modelname;

      /// Output name (string used for labelling in output, related to the model_functor which produced these parameters)
      /// Currently used only by the postprocessor ScannerBit plugin and reader plugins.
      std::string outputname;

  };

}
#endif //ifdef __model_parameters_hpp__

Updated on 2024-07-18 at 13:53:32 +0000