gadget2/reference/migrationpenalty_8h_source.html

 #ifndef migrationpenalty_h

 #define migrationpenalty_h


 #include "migration.h"

 #include "stock.h"


 class MigrationPenalty : public Likelihood {

 public:

   MigrationPenalty(CommentStream& infile, double weight, const char* name);

   virtual ~MigrationPenalty();

   virtual void addLikelihood(const TimeClass* const TimeInfo);

   void setFleetsAndStocks(FleetPtrVector& Fleets, StockPtrVector& Stocks);

   virtual void Reset(const Keeper* const keeper);

   virtual void printSummary(ofstream& outfile);

   virtual void Print(ofstream& outfile) const;

 private:

   char* stockname;

   Stock* stock;

   DoubleVector powercoeffs;

 };


 #endif

CommentStream
This is the class used to strip comments (and whitespace) from any input stream.
Definition: commentstream.h:40

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

FleetPtrVector
This class implements a dynamic vector of Fleet values.
Definition: fleetptrvector.h:10

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

Likelihood
This is the base class used to calculate the likelihood scores used to compare the modelled data in t...
Definition: likelihood.h:24

Likelihood::weight
double weight
This stores the weight to be applied to the likelihood component.
Definition: likelihood.h:112

MigrationPenalty
This is the class used to calculate the likelihood scores based on population errors arising from inc...
Definition: migrationpenalty.h:13

MigrationPenalty::setFleetsAndStocks
void setFleetsAndStocks(FleetPtrVector &Fleets, StockPtrVector &Stocks)
This will select the fleets and stocks required to calculate the MigrationPenalty likelihood score.
Definition: migrationpenalty.cc:47

MigrationPenalty::MigrationPenalty
MigrationPenalty(CommentStream &infile, double weight, const char *name)
This is the default MigrationPenalty constructor.
Definition: migrationpenalty.cc:7

MigrationPenalty::Reset
virtual void Reset(const Keeper *const keeper)
This function will reset the MigrationPenalty likelihood information.
Definition: migrationpenalty.cc:66

MigrationPenalty::~MigrationPenalty
virtual ~MigrationPenalty()
This is the default MigrationPenalty destructor.
Definition: migrationpenalty.cc:62

MigrationPenalty::addLikelihood
virtual void addLikelihood(const TimeClass *const TimeInfo)
This function will calculate the likelihood score for the current model.
Definition: migrationpenalty.cc:27

MigrationPenalty::Print
virtual void Print(ofstream &outfile) const
This function will print the summary MigrationPenalty likelihood information.
Definition: migrationpenalty.cc:82

MigrationPenalty::printSummary
virtual void printSummary(ofstream &outfile)
This function will print summary information from the MigrationPenalty likelihood calculation.
Definition: migrationpenalty.cc:72

StockPtrVector
This class implements a dynamic vector of Stock values.
Definition: stockptrvector.h:10

Stock
This is the class used to model a stock within the Gadget model.
Definition: stock.h:33

TimeClass
This is the class used to store information about the timesteps used for the current model.
Definition: areatime.h:87

migration.h

stock.h