rcpp_fleet.hpp

Go to the documentation of this file.

 
#ifndef FIMS_INTERFACE_RCPP_RCPP_OBJECTS_RCPP_FLEET_HPP
#define FIMS_INTERFACE_RCPP_RCPP_OBJECTS_RCPP_FLEET_HPP
 
#include "../../../common/def.hpp"
#include "../../../population_dynamics/fleet/fleet.hpp"
#include "rcpp_interface_base.hpp"
 
class FleetInterfaceBase : public FIMSRcppInterfaceBase {
 public:
  static uint32_t id_g;
  uint32_t id;
  static std::map<uint32_t, std::shared_ptr<FleetInterfaceBase>> live_objects;
 
  FleetInterfaceBase() {
    this->id = FleetInterfaceBase::id_g++;
    /* Create instance of map: key is id and value is pointer to
    FleetInterfaceBase */
    // FleetInterfaceBase::live_objects[this->id] = this;
  }
 
  FleetInterfaceBase(const FleetInterfaceBase &other) : id(other.id) {}
 
  virtual ~FleetInterfaceBase() {}
 
  virtual uint32_t get_id() = 0;
};
// static id of the FleetInterfaceBase object
uint32_t FleetInterfaceBase::id_g = 1;
// local id of the FleetInterfaceBase object map relating the ID of the
// FleetInterfaceBase to the FleetInterfaceBase objects
std::map<uint32_t, std::shared_ptr<FleetInterfaceBase>>
    FleetInterfaceBase::live_objects;
class FleetInterface : public FleetInterfaceBase {
  SharedInt interface_observed_agecomp_data_id_m = -999;
  SharedInt interface_observed_lengthcomp_data_id_m = -999;
  SharedInt interface_observed_index_data_id_m = -999;
  SharedInt interface_observed_landings_data_id_m = -999;
  SharedInt interface_selectivity_id_m = -999;
 
 public:
  SharedString name = fims::to_string("NA");
  SharedInt n_ages = 0;
  SharedInt n_lengths = 0;
  SharedInt n_years = 0;
  SharedString observed_landings_units = fims::to_string("weight");
  SharedString observed_index_units = fims::to_string("weight");
  ParameterVector log_q;
  ParameterVector log_Fmort;
  ParameterVector log_landings_expected;
  ParameterVector log_index_expected;
  ParameterVector agecomp_expected;
  ParameterVector lengthcomp_expected;
  ParameterVector agecomp_proportion;
  ParameterVector lengthcomp_proportion;
  ParameterVector age_to_length_conversion;
 
  // derived quantities
  Rcpp::NumericVector derived_landings_naa;
  Rcpp::NumericVector derived_landings_nal;
  Rcpp::NumericVector derived_landings_waa;
  Rcpp::NumericVector derived_landings_expected;
  Rcpp::NumericVector derived_landings_w;
  Rcpp::NumericVector derived_landings_n;
  Rcpp::NumericVector derived_index_naa;
  Rcpp::NumericVector derived_index_nal;
  Rcpp::NumericVector derived_index_waa;
  Rcpp::NumericVector derived_index_expected;
  Rcpp::NumericVector derived_index_w;
  Rcpp::NumericVector derived_index_n;
  Rcpp::NumericVector derived_agecomp_proportion;
  Rcpp::NumericVector derived_lengthcomp_proportion;
  Rcpp::NumericVector derived_agecomp_expected;
  Rcpp::NumericVector derived_lengthcomp_expected;
 
  FleetInterface() : FleetInterfaceBase() {
    std::shared_ptr<FleetInterface> fleet =
        std::make_shared<FleetInterface>(*this);
    FIMSRcppInterfaceBase::fims_interface_objects.push_back(fleet);
    /* Create instance of map: key is id and value is pointer to
     FleetInterfaceBase */
    FleetInterfaceBase::live_objects[this->id] = fleet;
  }
 
  FleetInterface(const FleetInterface &other)
      : FleetInterfaceBase(other),
        interface_observed_agecomp_data_id_m(
            other.interface_observed_agecomp_data_id_m),
        interface_observed_lengthcomp_data_id_m(
            other.interface_observed_lengthcomp_data_id_m),
        interface_observed_index_data_id_m(
            other.interface_observed_index_data_id_m),
        interface_observed_landings_data_id_m(
            other.interface_observed_landings_data_id_m),
        interface_selectivity_id_m(other.interface_selectivity_id_m),
        name(other.name),
        n_ages(other.n_ages),
        n_lengths(other.n_lengths),
        n_years(other.n_years),
        observed_landings_units(other.observed_landings_units),
        observed_index_units(other.observed_index_units),
        log_q(other.log_q),
        log_Fmort(other.log_Fmort),
        log_landings_expected(other.log_landings_expected),
        log_index_expected(other.log_index_expected),
        agecomp_expected(other.agecomp_expected),
        lengthcomp_expected(other.lengthcomp_expected),
        agecomp_proportion(other.agecomp_proportion),
        lengthcomp_proportion(other.lengthcomp_proportion),
        age_to_length_conversion(other.age_to_length_conversion),
        derived_landings_naa(other.derived_landings_naa),
        derived_landings_nal(other.derived_landings_nal),
        derived_landings_waa(other.derived_landings_waa),
        derived_landings_expected(other.derived_landings_expected),
        derived_landings_w(other.derived_landings_w),
        derived_landings_n(other.derived_landings_n),
        derived_index_naa(other.derived_index_naa),
        derived_index_nal(other.derived_index_nal),
        derived_index_waa(other.derived_index_waa),
        derived_index_expected(other.derived_index_expected),
        derived_index_w(other.derived_index_w),
        derived_index_n(other.derived_index_n),
        derived_agecomp_proportion(other.derived_agecomp_proportion),
        derived_lengthcomp_proportion(other.derived_lengthcomp_proportion),
        derived_agecomp_expected(other.derived_agecomp_expected),
        derived_lengthcomp_expected(other.derived_lengthcomp_expected) {}
 
  virtual ~FleetInterface() {}
 
  virtual uint32_t get_id() { return this->id; }
 
  void SetName(const std::string &name) { this->name.set(name); }
 
  std::string GetName() const { return this->name.get(); }
 
  void SetObservedAgeCompDataID(int observed_agecomp_data_id) {
    interface_observed_agecomp_data_id_m.set(observed_agecomp_data_id);
  }
 
  void SetObservedLengthCompDataID(int observed_lengthcomp_data_id) {
    interface_observed_lengthcomp_data_id_m.set(observed_lengthcomp_data_id);
  }
 
  void SetObservedIndexDataID(int observed_index_data_id) {
    interface_observed_index_data_id_m.set(observed_index_data_id);
  }
 
  void SetObservedLandingsDataID(int observed_landings_data_id) {
    interface_observed_landings_data_id_m.set(observed_landings_data_id);
  }
  void SetSelectivityID(int selectivity_id) {
    interface_selectivity_id_m.set(selectivity_id);
  }
 
  uint32_t GetSelectivityID() { return interface_selectivity_id_m.get(); }
 
  int GetObservedAgeCompDataID() {
    return interface_observed_agecomp_data_id_m.get();
  }
 
  int GetObservedLengthCompDataID() {
    return interface_observed_lengthcomp_data_id_m.get();
  }
 
  int GetObservedIndexDataID() {
    return interface_observed_index_data_id_m.get();
  }
 
  int GetObservedLandingsDataID() {
    return interface_observed_landings_data_id_m.get();
  }
  virtual void finalize() {
    if (this->finalized) {
      // log warning that finalize has been called more than once.
      FIMS_WARNING_LOG("Fleet " + fims::to_string(this->id) +
                       " has been finalized already.");
    }
 
    this->finalized = true;  // indicate this has been called already
 
    std::shared_ptr<fims_info::Information<double>> info =
        fims_info::Information<double>::GetInstance();
 
    fims_info::Information<double>::fleet_iterator it;
 
    it = info->fleets.find(this->id);
 
    if (it == info->fleets.end()) {
      FIMS_WARNING_LOG("Fleet " + fims::to_string(this->id) +
                       " not found in Information.");
      return;
    } else {
      std::shared_ptr<fims_popdy::Fleet<double>> fleet =
          std::dynamic_pointer_cast<fims_popdy::Fleet<double>>(it->second);
 
      for (size_t i = 0; i < this->log_Fmort.size(); i++) {
        if (this->log_Fmort[i].estimation_type_m.get() == "constant") {
          this->log_Fmort[i].final_value_m = this->log_Fmort[i].initial_value_m;
        } else {
          this->log_Fmort[i].final_value_m = fleet->log_Fmort[i];
        }
      }
 
      for (size_t i = 0; i < this->log_q.size(); i++) {
        if (this->log_q[i].estimation_type_m.get() == "constant") {
          this->log_q[i].final_value_m = this->log_q[i].initial_value_m;
        } else {
          this->log_q[i].final_value_m = fleet->log_q[i];
        }
      }
 
      for (size_t i = 0; i < fleet->age_to_length_conversion.size(); i++) {
        if (this->age_to_length_conversion[i].estimation_type_m.get() ==
            "constant") {
          this->age_to_length_conversion[i].final_value_m =
              this->age_to_length_conversion[i].initial_value_m;
        } else {
          this->age_to_length_conversion[i].final_value_m =
              fleet->age_to_length_conversion[i];
        }
      }
    }
  }
 
#ifdef TMB_MODEL
 
  template <typename Type>
  bool add_to_fims_tmb_internal() {
    std::shared_ptr<fims_info::Information<Type>> info =
        fims_info::Information<Type>::GetInstance();
 
    std::shared_ptr<fims_popdy::Fleet<Type>> fleet =
        std::make_shared<fims_popdy::Fleet<Type>>();
 
    std::stringstream ss;
 
    // set relative info
    fleet->id = this->id;
    fleet->n_ages = this->n_ages.get();
    fleet->n_lengths = this->n_lengths.get();
    fleet->n_years = this->n_years.get();
    fleet->observed_landings_units = this->observed_landings_units;
    fleet->observed_index_units = this->observed_index_units;
 
    fleet->fleet_observed_agecomp_data_id_m =
        interface_observed_agecomp_data_id_m.get();
 
    fleet->fleet_observed_lengthcomp_data_id_m =
        interface_observed_lengthcomp_data_id_m.get();
 
    fleet->fleet_observed_index_data_id_m =
        interface_observed_index_data_id_m.get();
    fleet->fleet_observed_landings_data_id_m =
        interface_observed_landings_data_id_m.get();
 
    fleet->fleet_selectivity_id_m = interface_selectivity_id_m.get();
 
    fleet->log_q.resize(this->log_q.size());
    for (size_t i = 0; i < this->log_q.size(); i++) {
      fleet->log_q[i] = this->log_q[i].initial_value_m;
 
      if (this->log_q[i].estimation_type_m.get() == "fixed_effects") {
        ss.str("");
        ss << "Fleet." << this->id << ".log_q." << this->log_q[i].id_m;
        info->RegisterParameterName(ss.str());
        info->RegisterParameter(fleet->log_q[i]);
      }
      if (this->log_q[i].estimation_type_m.get() == "random_effects") {
        ss.str("");
        ss << "Fleet." << this->id << ".log_q." << this->log_q[i].id_m;
        info->RegisterRandomEffectName(ss.str());
        info->RegisterRandomEffect(fleet->log_q[i]);
      }
    }
 
    FIMS_INFO_LOG("adding Fleet fmort object to TMB");
    if (this->log_Fmort.size() != static_cast<size_t>(this->n_years.get())) {
      FIMS_ERROR_LOG("The size of `log_Fmort` does not match `n_years`: " +
                     fims::to_string(this->log_Fmort.size()) +
                     " != " + fims::to_string(this->n_years.get()));
      throw std::invalid_argument(
          "Fleet log_Fmort size mismatch."
          "Fleet log_Fmort is of size " +
          fims::to_string(this->log_Fmort.size()) +
          " and the number of years is " +
          fims::to_string(this->n_years.get()));
    }
    fleet->log_Fmort.resize(static_cast<size_t>(this->log_Fmort.size()));
    for (size_t i = 0; i < log_Fmort.size(); i++) {
      fleet->log_Fmort[i] = this->log_Fmort[i].initial_value_m;
 
      if (this->log_Fmort[i].estimation_type_m.get() == "fixed_effects") {
        ss.str("");
        ss << "Fleet." << this->id << ".log_Fmort." << this->log_Fmort[i].id_m;
        info->RegisterParameterName(ss.str());
        info->RegisterParameter(fleet->log_Fmort[i]);
      }
      if (this->log_Fmort[i].estimation_type_m.get() == "random_effects") {
        ss.str("");
        ss << "Fleet." << this->id << ".log_Fmort." << this->log_Fmort[i].id_m;
        info->RegisterRandomEffectName(ss.str());
        info->RegisterRandomEffect(fleet->log_Fmort[i]);
      }
    }
    // add to variable_map
    info->variable_map[this->log_Fmort.id_m] = &(fleet)->log_Fmort;
 
    if (this->n_lengths.get() > 0) {
      fleet->age_to_length_conversion.resize(
          this->age_to_length_conversion.size());
 
      if (this->age_to_length_conversion.size() !=
          static_cast<size_t>(this->n_ages.get() * this->n_lengths.get())) {
        FIMS_ERROR_LOG(
            "age_to_length_conversion don't match, " +
            fims::to_string(this->age_to_length_conversion.size()) + " != " +
            fims::to_string((this->n_ages.get() * this->n_lengths.get())));
      }
 
      for (size_t i = 0; i < fleet->age_to_length_conversion.size(); i++) {
        fleet->age_to_length_conversion[i] =
            this->age_to_length_conversion[i].initial_value_m;
        FIMS_INFO_LOG(" adding Fleet length object to TMB in loop " +
                      fims::to_string(i) + " of " +
                      fims::to_string(fleet->age_to_length_conversion.size()));
 
        if (this->age_to_length_conversion[i].estimation_type_m.get() ==
            "fixed_effects") {
          ss.str("");
          ss << "Fleet." << this->id << ".age_to_length_conversion."
             << this->age_to_length_conversion[i].id_m;
          info->RegisterParameterName(ss.str());
          info->RegisterParameter(fleet->age_to_length_conversion[i]);
        }
        if (this->age_to_length_conversion[i].estimation_type_m.get() ==
            "random_effects") {
          FIMS_ERROR_LOG(
              "age_to_length_conversion cannot be set to random effects");
        }
      }
 
      info->variable_map[this->age_to_length_conversion.id_m] =
          &(fleet)->age_to_length_conversion;
    }
 
    // add to Information
    info->fleets[fleet->id] = fleet;
    FIMS_INFO_LOG("done adding Fleet object to TMB");
    return true;
  }
 
  virtual bool add_to_fims_tmb() {
#ifdef TMBAD_FRAMEWORK
    this->add_to_fims_tmb_internal<TMB_FIMS_REAL_TYPE>();
    this->add_to_fims_tmb_internal<TMBAD_FIMS_TYPE>();
#else
    FIMS_INFO_LOG("adding Fleet object to TMB");
    this->add_to_fims_tmb_internal<TMB_FIMS_REAL_TYPE>();
    this->add_to_fims_tmb_internal<TMB_FIMS_FIRST_ORDER>();
    this->add_to_fims_tmb_internal<TMB_FIMS_SECOND_ORDER>();
    this->add_to_fims_tmb_internal<TMB_FIMS_THIRD_ORDER>();
#endif
 
    return true;
  }
 
#endif
};
 
#endif