make fims::Vector out of bounds error more informative

[Andrea-Havron-NOAA]

Currently when there is an out of bounds error on a fims::Vector, the following error is returned:

fims::Vector out of bounds

We can improve the information of this error message by adding the name of the vector and including index and size information in the error.

To Do Items:

• Add variable_name_m to fims::Vector class (file)
• Create a set_variable_name method in fims::Vector class to set the name
• Set fims::Vector names in rcpp_objects/rcpp_* files. (See example below)
• Enhance error message in inline Type &operator[](size_t pos) and inline const Type &operator[](size_t n) to include the name of the fims::Vector, the total size of the vector, and the index (subtract 1 to convert to R) throwing the error.

Example setting fims::Vector name:

for (size_t i = 0; i < this->slope.size(); i++) {
      selectivity->slope[i] = this->slope[i].initial_value_m;
      if (this->slope[i].estimation_type_m.get() == "fixed_effects") {
        ss.str("");
        ss << "Selectivity." << this->id << ".slope." << this->slope[i].id_m;
        info->RegisterParameterName(ss.str());
        info->RegisterParameter(selectivity->slope[i]);
      }
      if (this->slope[i].estimation_type_m.get() == "random_effects") {
        ss.str("");
        ss << "Selectivity." << this->id << ".slope." << this->slope[i].id_m;
        info->RegisterRandomEffectName(ss.str());
        info->RegisterRandomEffect(selectivity->slope[i]);
      }
    }

The above original code can be modified to:

ss.str("");
ss << "Selectivity." << this->id << ".slope
selectivity->slope.set_variable_name(ss.str());
for (size_t i = 0; i < this->slope.size(); i++) {
      selectivity->slope[i] = this->slope[i].initial_value_m;
      ss  << "." << this->slope[i].id_m;
      if (this->slope[i].estimation_type_m.get() == "fixed_effects") {
        info->RegisterParameterName(ss.str());
        info->RegisterParameter(selectivity->slope[i]);
      }
      if (this->slope[i].estimation_type_m.get() == "random_effects") {
        info->RegisterRandomEffectName(ss.str());
        info->RegisterRandomEffect(selectivity->slope[i]);
      }
    }

[msupernaw]

@Andrea-Havron-NOAA elements in a fims::Vector are templated with type Type and not guaranteed to have a field variable_name_m. Are you suggesting we use a nested try/catch in the interface to capture this info?

[Andrea-Havron-NOAA]

@Andrea-Havron-NOAA elements in a fims::Vector are templated with type Type and not guaranteed to have a field variable_name_m. Are you suggesting we use a nested try/catch in the interface to capture this info?

The fims::Vector class has a tag_m member. In my surplus production branch, I was getting an out of bounds error and I suspected it was recruitment devs so I expanded the error message in fims_vector.hpp:

 inline const Type &operator[](size_t pos) const {
    if (pos >= this->size()) {
      std::string error_msg = "fims::Vector out of bounds: index " + 
                              std::to_string(pos + 1) + " >= size " + 
                              std::to_string(this->size());
      if (!this->tag_m.empty()) {
        error_msg += " (vector: " + this->tag_m + ")";
      }
      throw std::invalid_argument(error_msg);
    }
    return this->vec_m[pos];
  }

and added recruitment->log_recruit_devs.set_tag("log_devs"); to recruitment.hpp.

This worked great and confirmed the recruitment devs vector was the one throwing the error, but I haven't fully developed the idea in the surplus production branch and I thought it better to pull it out and make it a separate issue. I think it would be better to use the field variable_name_m instead of tag_m.