gadget2/reference/keeper_8h_source.html

 #ifndef keeper_h

 #define keeper_h


 #include "likelihood.h"

 #include "likelihoodptrvector.h"

 #include "optinfoptrvector.h"

 #include "stochasticdata.h"

 #include "addresskeepermatrix.h"

 #include "strstack.h"


 class Keeper {

 public:

   Keeper();

   ~Keeper();

   void keepVariable(double& value, Parameter& attr);

   void deleteParameter(const double& var);

   void changeVariable(const double& pre, double& post);

   void setString(const char* str);

   void addString(const char* str);

   void addString(const string str);

   void clearLast();

   void clearAll();

   void storeVariables(double likvalue, const DoubleVector& point);

   void resetVariables();

   void scaleVariables();

   void getOptFlags(IntVector& opt) const;

   void getSwitches(ParameterVector& sw) const;

   void getLowerBounds(DoubleVector& lbs) const;

   void getUpperBounds(DoubleVector& ubs) const;

   void getInitialValues(DoubleVector& val) const;

   void getScaledValues(DoubleVector& val) const;

   void getCurrentValues(DoubleVector& val) const;

   void getOptLowerBounds(DoubleVector& lbs) const;

   void getOptUpperBounds(DoubleVector& ubs) const;

   void getOptInitialValues(DoubleVector& val) const;

   void getOptScaledValues(DoubleVector& val) const;

   int numVariables() const;

   int numOptVariables() const { return numoptvar; };

   void Update(int pos, double& value);

   void Update(const DoubleVector& val);

   void Update(const StochasticData* const Stoch);

   void openPrintFile(const char* const filename);

   void writeInitialInformation(const LikelihoodPtrVector& likevec);

   void writeValues(const LikelihoodPtrVector& likevec, int prec);

   void writeParams(const OptInfoPtrVector& optvec, const char* const filename, int prec, int interrupt);

   void writeBestValues();

   void checkBounds(const LikelihoodPtrVector& likevec) const;

   int boundsGiven() const { return boundsgiven; };

   double getBestLikelihoodScore() const { return bestlikelihood; };

 protected:

   AddressKeeperMatrix address;

   DoubleVector initialvalues;

   DoubleVector scaledvalues;

   DoubleVector values;

   DoubleVector bestvalues;

   IntVector opt;

   StrStack* stack;

   ParameterVector switches;

   DoubleVector lowerbds;

   DoubleVector upperbds;

   int numoptvar;

   int boundsgiven;

   double bestlikelihood;

   int fileopen;

   ofstream outfile;

 };


 #endif

addresskeepermatrix.h

AddressKeeperMatrix
This class implements a dynamic vector of AddressKeeperVector values.
Definition: addresskeepermatrix.h:11

DoubleVector
This class implements a dynamic vector of double values.
Definition: doublevector.h:11

IntVector
This class implements a dynamic vector of int values.
Definition: intvector.h:11

Keeper
This is the class used to store information about the variables that are used in model simulation.
Definition: keeper.h:17

Keeper::getBestLikelihoodScore
double getBestLikelihoodScore() const
This function will return the best likelihood score found so far by the optimisation process.
Definition: keeper.h:204

Keeper::storeVariables
void storeVariables(double likvalue, const DoubleVector &point)
This function will store the current value of the variables from the optimisation process.
Definition: keeper.cc:524

Keeper::clearAll
void clearAll()
This function will remove all of the text strings from the list used to describe variables.
Definition: keeper.cc:112

Keeper::checkBounds
void checkBounds(const LikelihoodPtrVector &likevec) const
This function will check that the values of the parameters are within the bounds specified in the inp...
Definition: keeper.cc:497

Keeper::outfile
ofstream outfile
This ofstream is the file that all the parameter information gets sent to.
Definition: keeper.h:266

Keeper::numoptvar
int numoptvar
This is the number of parameters to be optimised.
Definition: keeper.h:250

Keeper::bestvalues
DoubleVector bestvalues
This is the DoubleVector used to store the best values of the parameters that the optimisation proces...
Definition: keeper.h:225

Keeper::getOptInitialValues
void getOptInitialValues(DoubleVector &val) const
This function will return a copy of the initial value of the variables to be optimised.
Definition: keeper.cc:164

Keeper::setString
void setString(const char *str)
This function will set the text string that is used to describe a variable.
Definition: keeper.cc:116

Keeper::writeValues
void writeValues(const LikelihoodPtrVector &likevec, int prec)
This function will write current information about the model parameters to file.
Definition: keeper.cc:283

Keeper::~Keeper
~Keeper()
This is the default Keeper destructor.
Definition: keeper.cc:56

Keeper::getCurrentValues
void getCurrentValues(DoubleVector &val) const
This function will return a copy of the current value of the variables.
Definition: keeper.cc:133

Keeper::deleteParameter
void deleteParameter(const double &var)
This function will delete a variable from the internal list.
Definition: keeper.cc:65

Keeper::getOptLowerBounds
void getOptLowerBounds(DoubleVector &lbs) const
This function will return a copy of the lower bounds of the variables to be optimised.
Definition: keeper.cc:471

Keeper::numOptVariables
int numOptVariables() const
This function will return the number of variables to be optimised.
Definition: keeper.h:145

Keeper::addString
void addString(const char *str)
This function will add a text string that is used to describe a variable.
Definition: keeper.cc:121

Keeper::lowerbds
DoubleVector lowerbds
This is the DoubleVector used to store information about the lower bounds of the parameters.
Definition: keeper.h:242

Keeper::Keeper
Keeper()
This is the default Keeper constructor.
Definition: keeper.cc:10

Keeper::keepVariable
void keepVariable(double &value, Parameter &attr)
This function will register a variable in the internal list, along with an initial value.
Definition: keeper.cc:18

Keeper::openPrintFile
void openPrintFile(const char *const filename)
This function will open the output file and write header information.
Definition: keeper.cc:252

Keeper::bestlikelihood
double bestlikelihood
This is the best likelihood score found so far by the optimisation process.
Definition: keeper.h:258

Keeper::initialvalues
DoubleVector initialvalues
This is the DoubleVector used to store the initial values of the parameters.
Definition: keeper.h:213

Keeper::clearLast
void clearLast()
This function will remove the last text string from the list used to describe variables.
Definition: keeper.cc:108

Keeper::stack
StrStack * stack
This is the StrStack used to store information about the use of the parameters.
Definition: keeper.h:234

Keeper::getInitialValues
void getInitialValues(DoubleVector &val) const
This function will return a copy of the initial value of the variables.
Definition: keeper.cc:139

Keeper::switches
ParameterVector switches
This is the ParameterVector used to store information about the names of the parameters.
Definition: keeper.h:238

Keeper::address
AddressKeeperMatrix address
This is the AddressKeeperMatrix used to store information about the value and name of the parameters.
Definition: keeper.h:204

Keeper::scaleVariables
void scaleVariables()
This function will scale the variables to be optimised, for the Hooke & Jeeves and BFGS optimisation ...
Definition: keeper.cc:185

Keeper::resetVariables
void resetVariables()
This function will reset the variables that have been scaled, to be optimised using the Simulated Ann...
Definition: keeper.cc:177

Keeper::changeVariable
void changeVariable(const double &pre, double &post)
This function will replace the value of a variable with a new value.
Definition: keeper.cc:93

Keeper::writeInitialInformation
void writeInitialInformation(const LikelihoodPtrVector &likevec)
This function will write header information about the model parameters to file.
Definition: keeper.cc:263

Keeper::opt
IntVector opt
This is the IntVector used to store information about whether the parameters are to be optimised.
Definition: keeper.h:230

Keeper::getOptFlags
void getOptFlags(IntVector &opt) const
This function will return a copy of the flags to denote which variables will be optimsised.
Definition: keeper.cc:386

Keeper::fileopen
int fileopen
This is the flag used to denote whether an output file has been specified or not.
Definition: keeper.h:262

Keeper::getUpperBounds
void getUpperBounds(DoubleVector &ubs) const
This function will return a copy of the upper bounds of the variables.
Definition: keeper.cc:465

Keeper::numVariables
int numVariables() const
This function will return the number of variables.
Definition: keeper.cc:129

Keeper::boundsgiven
int boundsgiven
This is the flag used to denote whether the bounds of the parameters have been specified or not.
Definition: keeper.h:254

Keeper::getScaledValues
void getScaledValues(DoubleVector &val) const
This function will return a copy of the scaled value of the variables.
Definition: keeper.cc:145

Keeper::upperbds
DoubleVector upperbds
This is the DoubleVector used to store information about the upper bounds of the parameters.
Definition: keeper.h:246

Keeper::boundsGiven
int boundsGiven() const
This function will return the flag used to denote whether the bounds of the parameters have been spec...
Definition: keeper.h:199

Keeper::getSwitches
void getSwitches(ParameterVector &sw) const
This function will return a copy of the names of the variables.
Definition: keeper.cc:392

Keeper::Update
void Update(int pos, double &value)
This function will update one Keeper variable with a new value.
Definition: keeper.cc:222

Keeper::getLowerBounds
void getLowerBounds(DoubleVector &lbs) const
This function will return a copy of the lower bounds of the variables.
Definition: keeper.cc:459

Keeper::getOptUpperBounds
void getOptUpperBounds(DoubleVector &ubs) const
This function will return a copy of the upper bounds of the variables to be optimised.
Definition: keeper.cc:484

Keeper::writeBestValues
void writeBestValues()
This function will display information about the best values of the parameters found so far during an...
Definition: keeper.cc:240

Keeper::values
DoubleVector values
This is the DoubleVector used to store the values of the parameters.
Definition: keeper.h:221

Keeper::writeParams
void writeParams(const OptInfoPtrVector &optvec, const char *const filename, int prec, int interrupt)
This function will write final information about the model parameters to file in a column format (whi...
Definition: keeper.cc:398

Keeper::getOptScaledValues
void getOptScaledValues(DoubleVector &val) const
This function will return a copy of the scaled value of the variables to be optimised.
Definition: keeper.cc:151

Keeper::scaledvalues
DoubleVector scaledvalues
This is the DoubleVector used to store the scaled values of the parameters.
Definition: keeper.h:217

LikelihoodPtrVector
This class implements a dynamic vector of Likelihood values.
Definition: likelihoodptrvector.h:10

OptInfoPtrVector
This class implements a dynamic vector of OptInfo values.
Definition: optinfoptrvector.h:10

ParameterVector
This class implements a dynamic vector of Parameter values.
Definition: parametervector.h:12

Parameter
This is the class used to store the name of a variable used in the model simulation.
Definition: parameter.h:11

StochasticData
This is the class used to get values for the variables used in the model simulation....
Definition: stochasticdata.h:22

StrStack
This class implements a simple stack of string objects.
Definition: strstack.h:10

likelihood.h

likelihoodptrvector.h

optinfoptrvector.h

stochasticdata.h

strstack.h