Gambit::ModelParameters Class Reference

#include <model_parameters.hpp>

Collaboration diagram for Gambit::ModelParameters:

Public Member Functions
	ModelParameters ()
	Default constructor. More...
	ModelParameters (const std::vector< std::string > &)
	Constructor using vector of strings. More...
	ModelParameters (const char **)
	Constructor using array of char arrays. More...
double	getValue (std::string const &inkey) const
	Get value of named parameter. More...
const std::map< std::string, double > &	getValues () const
	Get values of all parameters. More...
std::map< std::string, double >::const_iterator	begin () const
	Get a const iterator to the first parameter map entry. More...
std::map< std::string, double >::const_iterator	end () const
	Get a const iterator to the last parameter map entry. More...
int	getNumberOfPars () const
	Get number of parameters stored in this object. More...
const double &	operator[] (std::string const &inkey) const
	Get parameter value using bracket operator. More...
const double &	at (std::string const &inkey) const
	Get parameter value using 'at' syntax. More...
void	setValue (std::string const &inkey, double const &value)
	Set single parameter value. More...
void	setValues (std::map< std::string, double > const &params_map, bool missing_is_error=true)
	Set many parameter values using a map. More...
void	setValues (ModelParameters const &donor, bool missing_is_error=true)
	Set many parameter values using another ModelParameters object. More...
std::vector< std::string >	getKeys () const
	Get parameter keys (names), probably for external iteration. More...
void	print () const
	Dump parameter names and values to stdout (should be for debugging only) More...
void	_definePar (const std::string &newkey)
	Define a parameter with name, value (i.e. add to internal map). Value is initialised to zero. More...
void	_definePars (const std::vector< std::string > &v)
	Define many new parameters at once via a vector of names. More...
void	_definePars (const char **array)
	Define many new parameters at once via an array of char arrays. More...
std::string	getModelName () const
	Getters/setters for model and output names. More...
std::string	getOutputName () const
void	setModelName (const std::string &)
void	setOutputName (const std::string &)

Protected Member Functions
void	assert_contains (std::string) const
	Checks if this model container holds a parameter match the supplied name. More...

Private Attributes
std::map< std::string, double >	_values
	Internal map representation of parameters and their values. More...
std::string	modelname
	Name of the model; intended mainly for more helpful error messages. More...
std::string	outputname
	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. More...

Friends
std::ostream &	operator<< (std::ostream &strm, const ModelParameters &me)
	Dump parameter names and values to stream (again for debugging only I think) More...

Detailed Description

Definition at line 53 of file model_parameters.hpp.

Constructor & Destructor Documentation

ModelParameters() [1/3]

Gambit::ModelParameters::ModelParameters

(

)

Default constructor.

Definition at line 52 of file model_parameters.cpp.

: _values(), modelname("None"), outputname("None") {}

ModelParameters() [2/3]

Gambit::ModelParameters::ModelParameters

(

const std::vector< std::string > &

paramlist

)

Constructor using vector of strings.

Definition at line 55 of file model_parameters.cpp.

References _definePars().

                                                                        : _values(), modelname("None"), outputname("None") 
   {
     _definePars(paramlist);
   }

Here is the call graph for this function:

ModelParameters() [3/3]

Gambit::ModelParameters::ModelParameters

(

const char **

paramlist

)

Constructor using array of char arrays.

Definition at line 61 of file model_parameters.cpp.

References _definePars().

                                                         : _values(), modelname("None"), outputname("None") 
   {
     _definePars(paramlist);
   }

Here is the call graph for this function:

Member Function Documentation

_definePar()

void Gambit::ModelParameters::_definePar

(

const std::string &

newkey

)

Define a parameter with name, value (i.e. add to internal map). Value is initialised to zero.

Definition at line 165 of file model_parameters.cpp.

References _values.

Referenced by _definePars(), and Gambit::model_functor::addParameter().

   {
     _values[newkey]=0.;
   }

Here is the caller graph for this function:

_definePars() [1/2]

void Gambit::ModelParameters::_definePars

(

const std::vector< std::string > &

v

)

Define many new parameters at once via a vector of names.

Definition at line 171 of file model_parameters.cpp.

References _definePar().

Referenced by ModelParameters().

   {
     for(std::vector<std::string>::const_iterator it = v.begin(); it != v.end(); ++it)
     {
       _definePar(*it);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

_definePars() [2/2]

void Gambit::ModelParameters::_definePars

(

const char **

array

)

Define many new parameters at once via an array of char arrays.

Definition at line 180 of file model_parameters.cpp.

References _definePar().

   {
     int i = 0;
     while (array[i] != 0)
     {
       _definePar(array[i]);
       i++;
     }
   }

Here is the call graph for this function:

assert_contains()

void Gambit::ModelParameters::assert_contains ( std::string  inkey ) const

protected

Checks if this model container holds a parameter match the supplied name.

ModelParameters class member function definitions.

Checks if this model container holds a parameter matching the supplied name

Definition at line 43 of file model_parameters.cpp.

References _values, getModelName(), LOCAL_INFO, and Gambit::model_error().

Referenced by at(), getValue(), operator[](), setValue(), and setValues().

   {
     if(_values.count(inkey)!=1) 
     { 
       model_error().raise(LOCAL_INFO, "ModelParameters object (with name "+getModelName()+") does not contain the requested parameter '"+inkey+"'.");
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

at()

const double & Gambit::ModelParameters::at

(

std::string const &

inkey

)

const

Get parameter value using 'at' syntax.

Get parameter value using 'at' operator This is no different to the bracket operator method, since keys cannot be added with the bracket method anyhow, but for people who are used to maps it is nice to have.

Definition at line 108 of file model_parameters.cpp.

References _values, and assert_contains().

   {
     assert_contains(inkey);
     return _values.at(inkey);
   }

Here is the call graph for this function:

begin()

std::map< std::string, double >::const_iterator Gambit::ModelParameters::begin

(

)

const

Get a const iterator to the first parameter map entry.

Definition at line 80 of file model_parameters.cpp.

References getValues().

Referenced by Gambit::model_functor::donateParameters().

   {
     return getValues().begin();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

end()

std::map< std::string, double >::const_iterator Gambit::ModelParameters::end

(

)

const

Get a const iterator to the last parameter map entry.

Definition at line 86 of file model_parameters.cpp.

References getValues().

Referenced by Gambit::model_functor::donateParameters().

   {
     return getValues().end();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

getKeys()

std::vector< std::string > Gambit::ModelParameters::getKeys

(

)

const

Get parameter keys (names), probably for external iteration.

Definition at line 144 of file model_parameters.cpp.

References _values.

Referenced by Gambit::PostProcessor::PPDriver::get_ModelParameters(), main(), and Gambit::PostProcessor::PPDriver::run_main_loop().

   {
     std::vector<std::string> parnames;
     for (std::map<std::string,double>::const_iterator it=_values.begin();it!=_values.end();it++)
     {
       parnames.push_back((*it).first);
     }
     return parnames;
   }

Here is the caller graph for this function:

getModelName()

std::string Gambit::ModelParameters::getModelName

(

)

const

Getters/setters for model and output names.

Definition at line 191 of file model_parameters.cpp.

References modelname.

Referenced by assert_contains(), and Gambit::model_functor::donateParameters().

{ return modelname; }

Here is the caller graph for this function:

getNumberOfPars()

int Gambit::ModelParameters::getNumberOfPars

(

)

const

Get number of parameters stored in this object.

Definition at line 92 of file model_parameters.cpp.

References _values.

   {
     return _values.size();
   }

getOutputName()

std::string Gambit::ModelParameters::getOutputName

(

)

const

Definition at line 192 of file model_parameters.cpp.

References outputname.

Referenced by Gambit::PostProcessor::PPDriver::run_main_loop().

{ return outputname; }

Here is the caller graph for this function:

getValue()

double Gambit::ModelParameters::getValue

(

std::string const &

inkey

)

const

Get value of named parameter.

Definition at line 67 of file model_parameters.cpp.

References _values, and assert_contains().

   {
     assert_contains(inkey);
     return _values.at(inkey);
   }

Here is the call graph for this function:

getValues()

const std::map< std::string, double > & Gambit::ModelParameters::getValues

(

)

const

Get values of all parameters.

Definition at line 74 of file model_parameters.cpp.

References _values.

Referenced by Gambit::Printers::_common_print(), begin(), end(), and setValues().

   {
     return _values;
   }

Here is the caller graph for this function:

operator[]()

const double & Gambit::ModelParameters::operator[]

(

std::string const &

inkey

)

const

Get parameter value using bracket operator.

Definition at line 98 of file model_parameters.cpp.

References _values, and assert_contains().

   {
     assert_contains(inkey);
     return _values.at(inkey);
   }

Here is the call graph for this function:

print()

void Gambit::ModelParameters::print

(

)

const

Dump parameter names and values to stdout (should be for debugging only)

Definition at line 155 of file model_parameters.cpp.

References _values.

   {
     std::cout << "ModelParameters: Printing: "<<std::endl;
     for (std::map<std::string,double>::const_iterator it=_values.begin();it!=_values.end();it++)
     {
       std::cout << "parameter: " << it->first << "; value: "<<it->second<<std::endl ;
     }
   }

setModelName()

void Gambit::ModelParameters::setModelName

(

const std::string &

in

)

Definition at line 193 of file model_parameters.cpp.

References modelname.

Referenced by Gambit::model_functor::setModelName().

{ modelname = in; }

Here is the caller graph for this function:

setOutputName()

void Gambit::ModelParameters::setOutputName

(

const std::string &

in

)

Definition at line 194 of file model_parameters.cpp.

References outputname.

{ outputname = in; }

setValue()

void Gambit::ModelParameters::setValue	(	std::string const &	inkey,
		double const &	value
	)

Set single parameter value.

Definition at line 116 of file model_parameters.cpp.

References _values, and assert_contains().

Referenced by main(), Gambit::MSSM20atX_to_MSSM25atX(), Gambit::MSSM25atX_to_MSSM30atX(), Gambit::MSSM30atX_to_MSSM63atX(), Gambit::MSSM_mA_to_MSSM_mhud(), Gambit::MSSMatX_to_MSSMatQ(), and Gambit::Models::set_many_to_one().

   {
     assert_contains(inkey);
     _values[inkey]=value;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

setValues() [1/2]

void Gambit::ModelParameters::setValues	(	std::map< std::string, double > const &	params_map,
		bool	missing_is_error = true
	)

Set many parameter values using a map.

Definition at line 129 of file model_parameters.cpp.

References _values, and assert_contains().

Referenced by Gambit::MSSM20atX_to_MSSM25atX(), Gambit::MSSM25atX_to_MSSM30atX(), Gambit::MSSM30atX_to_MSSM63atX(), Gambit::MSSM_mA_to_MSSM_mhud(), Gambit::MSSMatX_to_MSSMatQ(), and setValues().

   {
     typedef std::map<std::string,double>::const_iterator it_type;
     for(it_type iterator = params_map.begin();
         iterator != params_map.end(); 
         iterator++)
     {
       // iterator->first = key
       // iterator->second = value
       if (missing_is_error) assert_contains(iterator->first);
       if (_values.count(iterator->first)==1) _values[iterator->first]=iterator->second;
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

setValues() [2/2]

void Gambit::ModelParameters::setValues	(	ModelParameters const &	donor,
		bool	missing_is_error = true
	)

Set many parameter values using another ModelParameters object.

Definition at line 123 of file model_parameters.cpp.

References getValues(), and setValues().

   {
     setValues(donor.getValues(), missing_is_error); 
   }

Here is the call graph for this function:

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  strm, const ModelParameters &  me  )

friend

Dump parameter names and values to stream (again for debugging only I think)

Definition at line 109 of file model_parameters.hpp.

      {
        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;
      }

Member Data Documentation

_values

std::map<std::string,double> Gambit::ModelParameters::_values

private

Internal map representation of parameters and their values.

Definition at line 137 of file model_parameters.hpp.

Referenced by _definePar(), assert_contains(), at(), getKeys(), getNumberOfPars(), getValue(), getValues(), operator[](), print(), setValue(), and setValues().

modelname

std::string Gambit::ModelParameters::modelname

private

Name of the model; intended mainly for more helpful error messages.

Definition at line 140 of file model_parameters.hpp.

Referenced by getModelName(), and setModelName().

outputname

std::string Gambit::ModelParameters::outputname

private

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.

Definition at line 144 of file model_parameters.hpp.

Referenced by getOutputName(), and setOutputName().

---

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

• Utils/include/gambit/Utils/model_parameters.hpp
• Utils/src/model_parameters.cpp