View of /trunk/gadget/boundlikelihood.h

#ifndef boundlikelihood_h
#define boundlikelihood_h

#include "likelihood.h"
#include "areatime.h"
#include "commentstream.h"
#include "intvector.h"
#include "doublevector.h"
#include "parametervector.h"

/**
 * \class BoundLikelihood
 * \brief This is the class used to calculate the likelihood scores based on the bounds of the parameters for the current model
 *
 * This class calculates a penalty that is applied if any parameters go outside the specified bounds during the optimisation process.  The Simulated Annealing algorithm restricts the parameters to be within the bounds, so this component will give a zero likelihood score when that algorithm is being used.  The Hooke & Jeeves algorithm doesn't have this restriction, so a penalty is applied to any parameter that is beyond the bound, and the parameter is moved back to the bounds.  A 'reasonable' model will have a zero likelihood score from this component.
 */
class BoundLikelihood : public Likelihood {
public:
  /**
   * \brief This is the default BoundLikelihood contructor
   * \param infile is the CommentStream to read the likelihood parameters from
   * \param Area is the AreaClass for the current model
   * \param TimeInfo is the TimeClass for the current model
   * \param keeper is the Keeper for the current model
   * \param weight is the weight for the likelihood component
   * \param name is the name for the likelihood component
   */
  BoundLikelihood(CommentStream& infile, const AreaClass* const Area,
    const TimeClass* const TimeInfo, const Keeper* const keeper, double weight, const char* name);
  /**
   * \brief This is the default BoundLikelihood destructor
   */
  virtual ~BoundLikelihood() {};
  /**
   * \brief This function will reset the bounds information for the likelihood calculation
   * \param keeper is the Keeper for the current model
   */
  void Reset(const Keeper* const keeper);
  /**
   * \brief This function will calculate the likelihood score for the current model
   * \param TimeInfo is the TimeClass for the current model
   * \note This function is not used for this likelihood component
   */
  virtual void addLikelihood(const TimeClass* const TimeInfo) {};
  /**
   * \brief This function will print summary information from the BoundLikelihood likelihood calculation
   * \param outfile is the ofstream that all the model likelihood information gets sent to
   */
  virtual void printSummary(ofstream& outfile);
  /**
   * \brief This function will calculate the likelihood score for the current model after adjusting the parameters
   * \param TimeInfo is the TimeClass for the current model
   * \param keeper is the Keeper for the current model
   * \note keeper can adjust the value of the parameters to ensure that they are within the bounds
   */
  virtual void addLikelihoodKeeper(const TimeClass* const TimeInfo, Keeper* const keeper);
  /**
   * \brief This function will print the summary MigrationPenalty likelihood information
   * \param outfile is the ofstream that all the model information gets sent to
   * \note This function is not used for this likelihood component
   */
  virtual void Print(ofstream& outfile) const;
protected:
  /**
   * \brief This is the IntVector of the index of the parameters
   */
  IntVector switchnr;
  /**
   * \brief This is the DoubleVector of the upper bounds
   */
  DoubleVector upperbound;
  /**
   * \brief This is the DoubleVector of the lower bounds
   */
  DoubleVector lowerbound;
  /**
   * \brief This is the DoubleVector of the power applied when the bound has been exceeded
   */
  DoubleVector powers;
  /**
   * \brief This is the DoubleVector of the weights applied when the lower bound has been exceeded
   */
  DoubleVector lowerweights;
  /**
   * \brief This is the DoubleVector of the weights applied when the upper bound has been exceeded
   */
  DoubleVector upperweights;
  /**
   * \brief This is the DoubleVector of the penalty applied when the bound has been exceeded
   */
  DoubleVector likelihoods;
  /**
   * \brief This is the ParameterVector of the names of the input parameters
   */
  ParameterVector switches;
  /**
   * \brief This is the DoubleVector used to temporarily store the values of the parameters
   */
  DoubleVector values;
  /**
   * \brief This is the default weight applied when the lower bound is exceeded
   */
  double defLW;
  /**
   * \brief This is the default weight applied when the upper bound is exceeded
   */
  double defUW;
  /**
   * \brief This is the default power applied when the bound is exceeded
   */
  double defPower;
private:
  /**
   * \brief This is the flag used to check whether the vectors have been initialised
   */
  int checkInitialised;
};

#endif