recruitment_base.hpp

Go to the documentation of this file.

#ifndef FIMS_POPULATION_DYNAMICS_RECRUITMENT_BASE_HPP
#define FIMS_POPULATION_DYNAMICS_RECRUITMENT_BASE_HPP
 
#include <cmath>  // for using std::pow and M_PI
 
#include "common/fims_math.hpp"  // for using fims_math::log()
#include "common/fims_vector.hpp"
#include "common/model_object.hpp"
 
namespace fims_popdy {

template <class Type>
struct RecruitmentBase : public fims_model_object::FIMSObject<Type> {
  static uint32_t id_g; 
 
  fims::Vector<Type> log_recruit_devs; 
  bool constrain_deviations = false;   
 
  fims::Vector<Type> log_rzero; 
  fims::Vector<Type>
      log_r; 
  fims::Vector<Type>
      log_expected_recruitment; 
 
  bool estimate_log_recruit_devs = true; 
 
  int process_id = -999; 
  std::shared_ptr<fims_popdy::RecruitmentBase<Type>>
      process; 
  std::shared_ptr<fims_popdy::RecruitmentBase<Type>>
      recruitment; 

  RecruitmentBase() {
    this->id = RecruitmentBase::id_g++;
    this->register_self(this->id);
  }
 
  virtual ~RecruitmentBase() {}

  void Prepare() {
    // this->PrepareConstrainedDeviations();
    std::fill(log_expected_recruitment.begin(), log_expected_recruitment.end(),
              0.0);
  }

  virtual const Type evaluate_mean(const Type &spawners, const Type &phi_0) = 0;

  virtual const Type evaluate_process(size_t pos) = 0;

  void PrepareConstrainedDeviations() {
    if (!this->constrain_deviations) {
      return;
    }
 
    Type sum = static_cast<Type>(0.0);
 
    for (size_t i = 0; i < this->log_recruit_devs.size(); i++) {
      sum += this->log_recruit_devs[i];
    }
 
    for (size_t i = 0; i < this->log_recruit_devs.size(); i++) {
      this->log_recruit_devs[i] -= sum / (this->log_recruit_devs.size());
    }
  }
};
 
template <class Type>
uint32_t RecruitmentBase<Type>::id_g = 0;
}  // namespace fims_popdy
 
#endif /* FIMS_POPULATION_DYNAMICS_RECRUITMENT_BASE_HPP */