From 45853a19539bcf5b8a4e39847504f9fa6b3c18c6 Mon Sep 17 00:00:00 2001 From: Christine Stawitz Date: Tue, 31 Oct 2023 23:19:29 +0000 Subject: [PATCH] Docs: run Doxygen --- docs/annotated.html | 92 +- docs/classEWAAGrowthInterface.html | 4 +- docs/classes.html | 20 +- ...lassfims__info_1_1Information-members.html | 126 ++ docs/classfims__info_1_1Information.html | 1022 ++++++++++ docs/classfims__model_1_1Model-members.html | 93 + docs/classfims__model_1_1Model.html | 202 ++ docs/classfims__popdy_1_1Subpopulation.html | 95 + docs/data__object_8hpp_source.html | 148 +- docs/def_8hpp_source.html | 2 +- docs/distributions__base_8hpp.html | 4 +- docs/distributions__base_8hpp_source.html | 26 +- docs/double__logistic_8hpp_source.html | 36 +- docs/ewaa_8hpp_source.html | 22 +- docs/fims__math_8hpp.html | 146 +- docs/fims__math_8hpp_source.html | 72 +- docs/fleet_8hpp.html | 4 +- docs/fleet_8hpp_source.html | 236 +-- docs/functions.html | 8 +- docs/functions_b.html | 2 +- docs/functions_c.html | 42 +- docs/functions_d.html | 16 +- docs/functions_e.html | 48 +- docs/functions_f.html | 32 +- docs/functions_func.html | 136 +- docs/functions_g.html | 38 +- docs/functions_i.html | 28 +- docs/functions_j.html | 2 +- docs/functions_k.html | 2 +- docs/functions_l.html | 18 +- docs/functions_m.html | 24 +- docs/functions_n.html | 20 +- docs/functions_o.html | 6 +- docs/functions_p.html | 24 +- docs/functions_q.html | 2 +- docs/functions_r.html | 20 +- docs/functions_s.html | 24 +- docs/functions_type.html | 20 +- docs/functions_u.html | 6 +- docs/functions_vars.html | 212 +-- docs/functions_w.html | 2 +- docs/functions_y.html | 2 +- docs/functions_~.html | 2 +- docs/growth__base_8hpp_source.html | 24 +- docs/hierarchy.html | 85 +- docs/information_8hpp.html | 4 +- docs/information_8hpp_source.html | 268 +-- ...urity_2functors_2logistic_8hpp_source.html | 24 +- docs/maturity__base_8hpp_source.html | 24 +- docs/model_8hpp_source.html | 72 +- docs/model__object_8hpp_source.html | 36 +- docs/population_8hpp_source.html | 1053 +++++------ docs/rcpp__data_8hpp_source.html | 18 +- docs/rcpp__fleet_8hpp_source.html | 10 +- docs/rcpp__growth_8hpp_source.html | 22 +- docs/rcpp__interface_8hpp_source.html | 30 +- docs/rcpp__maturity_8hpp_source.html | 26 +- docs/rcpp__population_8hpp_source.html | 18 +- docs/rcpp__recruitment_8hpp_source.html | 46 +- docs/rcpp__selectivity_8hpp_source.html | 58 +- docs/rcpp__tmb__distribution_8hpp_source.html | 32 +- docs/recruitment__base_8hpp.html | 4 +- docs/recruitment__base_8hpp_source.html | 78 +- docs/search/all_0.js | 14 +- docs/search/all_1.js | 2 +- docs/search/all_10.js | 26 +- docs/search/all_11.js | 52 +- docs/search/all_12.js | 2 +- docs/search/all_13.js | 6 +- docs/search/all_14.js | 2 +- docs/search/all_15.js | 6 +- docs/search/all_16.js | 2 +- docs/search/all_17.js | 4 +- docs/search/all_18.js | 8 +- docs/search/all_2.js | 42 +- docs/search/all_3.js | 20 +- docs/search/all_4.js | 24 +- docs/search/all_5.js | 37 +- docs/search/all_6.js | 56 +- docs/search/all_7.js | 26 +- docs/search/all_8.js | 12 +- docs/search/all_9.js | 2 +- docs/search/all_a.js | 32 +- docs/search/all_b.js | 36 +- docs/search/all_c.js | 16 +- docs/search/all_d.js | 10 +- docs/search/all_e.js | 30 +- docs/search/all_f.js | 2 +- docs/search/classes_0.js | 2 +- docs/search/classes_1.js | 2 +- docs/search/classes_2.js | 18 +- docs/search/classes_3.js | 4 +- docs/search/classes_4.js | 13 +- docs/search/classes_5.js | 4 +- docs/search/classes_6.js | 4 +- docs/search/classes_7.js | 4 +- docs/search/classes_8.js | 8 +- docs/search/classes_9.js | 6 +- docs/search/classes_a.js | 2 +- docs/search/classes_b.js | 8 +- docs/search/classes_c.js | 4 +- docs/search/classes_d.js | 8 +- docs/search/enums_0.js | 2 +- docs/search/enumvalues_0.js | 2 +- docs/search/enumvalues_1.js | 2 +- docs/search/enumvalues_2.js | 4 +- docs/search/enumvalues_3.js | 2 +- docs/search/enumvalues_4.js | 2 +- docs/search/files_0.js | 4 +- docs/search/files_1.js | 6 +- docs/search/files_2.js | 2 +- docs/search/files_3.js | 2 +- docs/search/files_4.js | 2 +- docs/search/functions_0.js | 12 +- docs/search/functions_1.js | 32 +- docs/search/functions_2.js | 8 +- docs/search/functions_3.js | 14 +- docs/search/functions_4.js | 4 +- docs/search/functions_5.js | 46 +- docs/search/functions_6.js | 6 +- docs/search/functions_7.js | 2 +- docs/search/functions_8.js | 4 +- docs/search/functions_9.js | 4 +- docs/search/functions_a.js | 2 +- docs/search/functions_b.js | 8 +- docs/search/functions_c.js | 8 +- docs/search/functions_d.js | 26 +- docs/search/functions_e.js | 2 +- docs/search/functions_f.js | 8 +- docs/search/typedefs_0.js | 4 +- docs/search/typedefs_1.js | 2 +- docs/search/typedefs_2.js | 2 +- docs/search/typedefs_3.js | 4 +- docs/search/typedefs_4.js | 2 +- docs/search/typedefs_5.js | 4 +- docs/search/typedefs_6.js | 2 +- docs/search/typedefs_7.js | 2 +- docs/search/variables_0.js | 10 +- docs/search/variables_1.js | 2 +- docs/search/variables_10.js | 14 +- docs/search/variables_11.js | 16 +- docs/search/variables_12.js | 6 +- docs/search/variables_13.js | 2 +- docs/search/variables_14.js | 4 +- docs/search/variables_15.js | 2 +- docs/search/variables_16.js | 4 +- docs/search/variables_2.js | 10 +- docs/search/variables_3.js | 10 +- docs/search/variables_4.js | 24 +- docs/search/variables_5.js | 26 +- docs/search/variables_6.js | 6 +- docs/search/variables_7.js | 16 +- docs/search/variables_8.js | 2 +- docs/search/variables_9.js | 2 +- docs/search/variables_a.js | 20 +- docs/search/variables_b.js | 26 +- docs/search/variables_c.js | 10 +- docs/search/variables_d.js | 6 +- docs/search/variables_e.js | 12 +- docs/search/variables_f.js | 2 +- ...ivity_2functors_2logistic_8hpp_source.html | 26 +- docs/selectivity__base_8hpp_source.html | 26 +- docs/sr__beverton__holt_8hpp_source.html | 27 +- ...s__data__object_1_1DataObject-members.html | 118 ++ ...tructfims__data__object_1_1DataObject.html | 1018 ++++++++++ ...structfims__data__object_1_1DataObject.png | Bin 0 -> 887 bytes ...ibutions_1_1DistributionsBase-members.html | 98 + ...s__distributions_1_1DistributionsBase.html | 189 ++ ...ms__distributions_1_1DistributionsBase.png | Bin 0 -> 917 bytes ...__model__object_1_1FIMSObject-members.html | 94 + ...ructfims__model__object_1_1FIMSObject.html | 206 +++ ...tructfims__model__object_1_1FIMSObject.png | Bin 0 -> 5398 bytes ..._1_1DoubleLogisticSelectivity-members.html | 104 ++ ...s__popdy_1_1DoubleLogisticSelectivity.html | 264 +++ ...ms__popdy_1_1DoubleLogisticSelectivity.png | Bin 0 -> 1556 bytes ...ructfims__popdy_1_1EWAAgrowth-members.html | 101 + docs/structfims__popdy_1_1EWAAgrowth.html | 206 +++ docs/structfims__popdy_1_1EWAAgrowth.png | Bin 0 -> 1314 bytes docs/structfims__popdy_1_1Fleet-members.html | 127 ++ docs/structfims__popdy_1_1Fleet.html | 830 +++++++++ docs/structfims__popdy_1_1Fleet.png | Bin 0 -> 829 bytes ...ructfims__popdy_1_1GrowthBase-members.html | 98 + docs/structfims__popdy_1_1GrowthBase.html | 216 +++ docs/structfims__popdy_1_1GrowthBase.png | Bin 0 -> 1324 bytes ...ms__popdy_1_1LogisticMaturity-members.html | 100 + ...structfims__popdy_1_1LogisticMaturity.html | 228 +++ .../structfims__popdy_1_1LogisticMaturity.png | Bin 0 -> 1339 bytes ..._popdy_1_1LogisticSelectivity-members.html | 102 + ...uctfims__popdy_1_1LogisticSelectivity.html | 228 +++ ...ructfims__popdy_1_1LogisticSelectivity.png | Bin 0 -> 1342 bytes ...ctfims__popdy_1_1MaturityBase-members.html | 97 + docs/structfims__popdy_1_1MaturityBase.html | 216 +++ docs/structfims__popdy_1_1MaturityBase.png | Bin 0 -> 1347 bytes ...ructfims__popdy_1_1Population-members.html | 146 ++ docs/structfims__popdy_1_1Population.html | 1645 +++++++++++++++++ docs/structfims__popdy_1_1Population.png | Bin 0 -> 873 bytes ...ims__popdy_1_1RecruitmentBase-members.html | 106 ++ .../structfims__popdy_1_1RecruitmentBase.html | 366 ++++ docs/structfims__popdy_1_1RecruitmentBase.png | Bin 0 -> 1317 bytes ...fims__popdy_1_1SRBevertonHolt-members.html | 109 ++ docs/structfims__popdy_1_1SRBevertonHolt.html | 246 +++ docs/structfims__popdy_1_1SRBevertonHolt.png | Bin 0 -> 1307 bytes ...ims__popdy_1_1SelectivityBase-members.html | 98 + .../structfims__popdy_1_1SelectivityBase.html | 217 +++ docs/structfims__popdy_1_1SelectivityBase.png | Bin 0 -> 2185 bytes docs/subpopulation_8hpp_source.html | 8 +- docs/tmb__distributions_8hpp_source.html | 46 +- 207 files changed, 11436 insertions(+), 2314 deletions(-) create mode 100644 docs/classfims__info_1_1Information-members.html create mode 100644 docs/classfims__info_1_1Information.html create mode 100644 docs/classfims__model_1_1Model-members.html create mode 100644 docs/classfims__model_1_1Model.html create mode 100644 docs/classfims__popdy_1_1Subpopulation.html create mode 100644 docs/structfims__data__object_1_1DataObject-members.html create mode 100644 docs/structfims__data__object_1_1DataObject.html create mode 100644 docs/structfims__data__object_1_1DataObject.png create mode 100644 docs/structfims__distributions_1_1DistributionsBase-members.html create mode 100644 docs/structfims__distributions_1_1DistributionsBase.html create mode 100644 docs/structfims__distributions_1_1DistributionsBase.png create mode 100644 docs/structfims__model__object_1_1FIMSObject-members.html create mode 100644 docs/structfims__model__object_1_1FIMSObject.html create mode 100644 docs/structfims__model__object_1_1FIMSObject.png create mode 100644 docs/structfims__popdy_1_1DoubleLogisticSelectivity-members.html create mode 100644 docs/structfims__popdy_1_1DoubleLogisticSelectivity.html create mode 100644 docs/structfims__popdy_1_1DoubleLogisticSelectivity.png create mode 100644 docs/structfims__popdy_1_1EWAAgrowth-members.html create mode 100644 docs/structfims__popdy_1_1EWAAgrowth.html create mode 100644 docs/structfims__popdy_1_1EWAAgrowth.png create mode 100644 docs/structfims__popdy_1_1Fleet-members.html create mode 100644 docs/structfims__popdy_1_1Fleet.html create mode 100644 docs/structfims__popdy_1_1Fleet.png create mode 100644 docs/structfims__popdy_1_1GrowthBase-members.html create mode 100644 docs/structfims__popdy_1_1GrowthBase.html create mode 100644 docs/structfims__popdy_1_1GrowthBase.png create mode 100644 docs/structfims__popdy_1_1LogisticMaturity-members.html create mode 100644 docs/structfims__popdy_1_1LogisticMaturity.html create mode 100644 docs/structfims__popdy_1_1LogisticMaturity.png create mode 100644 docs/structfims__popdy_1_1LogisticSelectivity-members.html create mode 100644 docs/structfims__popdy_1_1LogisticSelectivity.html create mode 100644 docs/structfims__popdy_1_1LogisticSelectivity.png create mode 100644 docs/structfims__popdy_1_1MaturityBase-members.html create mode 100644 docs/structfims__popdy_1_1MaturityBase.html create mode 100644 docs/structfims__popdy_1_1MaturityBase.png create mode 100644 docs/structfims__popdy_1_1Population-members.html create mode 100644 docs/structfims__popdy_1_1Population.html create mode 100644 docs/structfims__popdy_1_1Population.png create mode 100644 docs/structfims__popdy_1_1RecruitmentBase-members.html create mode 100644 docs/structfims__popdy_1_1RecruitmentBase.html create mode 100644 docs/structfims__popdy_1_1RecruitmentBase.png create mode 100644 docs/structfims__popdy_1_1SRBevertonHolt-members.html create mode 100644 docs/structfims__popdy_1_1SRBevertonHolt.html create mode 100644 docs/structfims__popdy_1_1SRBevertonHolt.png create mode 100644 docs/structfims__popdy_1_1SelectivityBase-members.html create mode 100644 docs/structfims__popdy_1_1SelectivityBase.html create mode 100644 docs/structfims__popdy_1_1SelectivityBase.png diff --git a/docs/annotated.html b/docs/annotated.html index 2d2e4ed..b312c14 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -75,49 +75,55 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Nfims
 CDataObject
 Cfims_log
 CInformationStores FIMS model information and creates model. Contains all objects and data pre-model construction
 CModelModel class. FIMS objective function
 CFIMSObjectFIMSObject struct that defines member types and returns the unique id
 CDistributionsBaseBase class for all module_name functors
 CFleetBase class for all fleets
 CEWAAgrowthEWAAgrowth class that returns the EWAA function value
 CGrowthBaseBase class for all growth functors
 CLogisticMaturityLogisticMaturity class that returns the logistic function value from fims_math
 CMaturityBaseBase class for all maturity functors
 CPopulationPopulation class. Contains subpopulations that are divided into generic partitions (eg. sex, area)
 CSubpopulation
 CRecruitmentBaseBase class for all recruitment functors
 CSRBevertonHoltBevertonHolt class that returns the Beverton Holt SR from fims_math
 CDoubleLogisticSelectivityDoubleLogisticSelectivity class that returns the double logistic function value from fims_math
 CLogisticSelectivityLogisticSelectivity class that returns the logistic function value from fims_math
 CSelectivityBaseBase class for all selectivity functors
 CAgeCompDataInterfaceRcpp interface for age comp data as an S4 object. To instantiate from R: acomp <- new(fims$AgeComp)
 CBevertonHoltRecruitmentInterfaceRcpp interface for Beverton-Holt as an S4 object. To instantiate from R: beverton_holt <- new(fims$beverton_holt)
 CDataInterfaceBaseRcpp interface for Data as an S4 object. To instantiate from R: fleet <- new(fims$Data)
 CDistributionsInterfaceBaseDistributions Rcpp Interface
 CDlnormDistributionsInterfaceRcpp interface for Dlnorm as an S4 object. To instantiate from R: dlnorm_ <- new(fims$TMBDlnormDistribution)
 CDmultinomDistributionsInterfaceRcpp interface for Dmultinom as an S4 object. To instantiate from R: dmultinom_ <- new(fims$TMBDmultinomDistribution)
 CDnormDistributionsInterfaceRcpp interface for Dnorm as an S4 object. To instantiate from R: dnorm_ <- new(fims$TMBDnormDistribution)
 CDoubleLogisticSelectivityInterfaceRcpp interface for logistic selectivity as an S4 object. To instantiate from R: logistic_selectivity <- new(fims$logistic_selectivity)
 CEWAAGrowthInterfaceRcpp interface for EWAAgrowth as an S4 object. To instantiate from R: ewaa <- new(fims$EWAAgrowth)
 CFIMSRcppInterfaceBaseBase class for all interface objects
 CFleetInterfaceRcpp interface for Fleet as an S4 object. To instantiate from R: fleet <- new(fims$Fleet)
 CFleetInterfaceBaseRcpp interface that serves as the parent class for Rcpp fleet interfaces. This type should be inherited and not called from R directly
 CGrowthInterfaceBaseRcpp interface that serves as the parent class for Rcpp growth interfaces. This type should be inherited and not called from R directly
 CIndexDataInterfaceRcpp interface for data as an S4 object. To instantiate from R: fleet <- new(fims$Index)
 CJsonParserParses JSON strings and generates JSON values
 CJsonValueRepresents a JSON value
 CLogisticMaturityInterfaceRcpp interface for logistic maturity as an S4 object. To instantiate from R: logistic_maturity <- new(fims$logistic_maturity)
 CLogisticSelectivityInterfaceRcpp interface for logistic selectivity as an S4 object. To instantiate from R: logistic_selectivity <- new(fims$logistic_selectivity)
 CMaturityInterfaceBaseMaturityInterfaceBase class should be inherited to define different Rcpp interfaces for each possible maturity function
 CNLLInterfaceBaseNLLInterfaceBase class should be inherited to define different Rcpp interfaces for each possible negative log-likelihood function
 CParameterRcppInterface class that defines the interface between R and C++ for parameter types
 CPopulationInterfaceRcpp interface for a new Population. To instantiate from R: population <- new(fims$population)
 CPopulationInterfaceBasePopulationInterfaceBase class should be inherited to define different Rcpp interfaces for each possible Population function
 CRecruitmentInterfaceBaseRecruitmentInterfaceBase class should be inherited to define different Rcpp interfaces for each possible Recruitment function
 CSelectivityInterfaceBaseSelectivityInterfaceBase class should be inherited to define different Rcpp interfaces for each possible Selectivity function
 Cfims_log
 Nfims_data_object
 CDataObject
 Nfims_distributions
 CDistributionsBaseBase class for all module_name functors
 Nfims_info
 CInformationStores FIMS model information and creates model. Contains all objects and data pre-model construction
 Nfims_model
 CModelModel class. FIMS objective function
 Nfims_model_object
 CFIMSObjectFIMSObject struct that defines member types and returns the unique id
 Nfims_popdy
 CFleetBase class for all fleets
 CEWAAgrowthEWAAgrowth class that returns the EWAA function value
 CGrowthBaseBase class for all growth functors
 CLogisticMaturityLogisticMaturity class that returns the logistic function value from fims_math
 CMaturityBaseBase class for all maturity functors
 CPopulationPopulation class. Contains subpopulations that are divided into generic partitions (eg. sex, area)
 CSubpopulation
 CRecruitmentBaseBase class for all recruitment functors
 CSRBevertonHoltBevertonHolt class that returns the Beverton Holt SR from fims_math
 CDoubleLogisticSelectivityDoubleLogisticSelectivity class that returns the double logistic function value from fims_math
 CLogisticSelectivityLogisticSelectivity class that returns the logistic function value from fims_math
 CSelectivityBaseBase class for all selectivity functors
 CAgeCompDataInterfaceRcpp interface for age comp data as an S4 object. To instantiate from R: acomp <- new(fims$AgeComp)
 CBevertonHoltRecruitmentInterfaceRcpp interface for Beverton-Holt as an S4 object. To instantiate from R: beverton_holt <- new(fims$beverton_holt)
 CDataInterfaceBaseRcpp interface for Data as an S4 object. To instantiate from R: fleet <- new(fims$Data)
 CDistributionsInterfaceBaseDistributions Rcpp Interface
 CDlnormDistributionsInterfaceRcpp interface for Dlnorm as an S4 object. To instantiate from R: dlnorm_ <- new(fims$TMBDlnormDistribution)
 CDmultinomDistributionsInterfaceRcpp interface for Dmultinom as an S4 object. To instantiate from R: dmultinom_ <- new(fims$TMBDmultinomDistribution)
 CDnormDistributionsInterfaceRcpp interface for Dnorm as an S4 object. To instantiate from R: dnorm_ <- new(fims$TMBDnormDistribution)
 CDoubleLogisticSelectivityInterfaceRcpp interface for logistic selectivity as an S4 object. To instantiate from R: logistic_selectivity <- new(fims$logistic_selectivity)
 CEWAAGrowthInterfaceRcpp interface for EWAAgrowth as an S4 object. To instantiate from R: ewaa <- new(fims$EWAAgrowth)
 CFIMSRcppInterfaceBaseBase class for all interface objects
 CFleetInterfaceRcpp interface for Fleet as an S4 object. To instantiate from R: fleet <- new(fims$Fleet)
 CFleetInterfaceBaseRcpp interface that serves as the parent class for Rcpp fleet interfaces. This type should be inherited and not called from R directly
 CGrowthInterfaceBaseRcpp interface that serves as the parent class for Rcpp growth interfaces. This type should be inherited and not called from R directly
 CIndexDataInterfaceRcpp interface for data as an S4 object. To instantiate from R: fleet <- new(fims$Index)
 CJsonParserParses JSON strings and generates JSON values
 CJsonValueRepresents a JSON value
 CLogisticMaturityInterfaceRcpp interface for logistic maturity as an S4 object. To instantiate from R: logistic_maturity <- new(fims$logistic_maturity)
 CLogisticSelectivityInterfaceRcpp interface for logistic selectivity as an S4 object. To instantiate from R: logistic_selectivity <- new(fims$logistic_selectivity)
 CMaturityInterfaceBaseMaturityInterfaceBase class should be inherited to define different Rcpp interfaces for each possible maturity function
 CNLLInterfaceBaseNLLInterfaceBase class should be inherited to define different Rcpp interfaces for each possible negative log-likelihood function
 CParameterRcppInterface class that defines the interface between R and C++ for parameter types
 CPopulationInterfaceRcpp interface for a new Population. To instantiate from R: population <- new(fims$population)
 CPopulationInterfaceBasePopulationInterfaceBase class should be inherited to define different Rcpp interfaces for each possible Population function
 CRecruitmentInterfaceBaseRecruitmentInterfaceBase class should be inherited to define different Rcpp interfaces for each possible Recruitment function
 CSelectivityInterfaceBaseSelectivityInterfaceBase class should be inherited to define different Rcpp interfaces for each possible Selectivity function
diff --git a/docs/classEWAAGrowthInterface.html b/docs/classEWAAGrowthInterface.html index 03d31ce..3a42e50 100644 --- a/docs/classEWAAGrowthInterface.html +++ b/docs/classEWAAGrowthInterface.html @@ -176,8 +176,8 @@

Parameters
- - + +
weightsT vector of weights
agesT vector of ages
weightsType vector of weights
agesType vector of ages
diff --git a/docs/classes.html b/docs/classes.html index 666d51f..e929951 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -82,40 +82,40 @@
BevertonHoltRecruitmentInterface
D
-
DataInterfaceBase
DataObject (fims)
DistributionsBase (fims)
DistributionsInterfaceBase
DlnormDistributionsInterface
DmultinomDistributionsInterface
DnormDistributionsInterface
DoubleLogisticSelectivity (fims)
DoubleLogisticSelectivityInterface
+
DataInterfaceBase
DataObject (fims_data_object)
DistributionsBase (fims_distributions)
DistributionsInterfaceBase
DlnormDistributionsInterface
DmultinomDistributionsInterface
DnormDistributionsInterface
DoubleLogisticSelectivity (fims_popdy)
DoubleLogisticSelectivityInterface
E
-
EWAAgrowth (fims)
EWAAGrowthInterface
+
EWAAgrowth (fims_popdy)
EWAAGrowthInterface
F
-
fims_log (fims)
FIMSObject (fims)
FIMSRcppInterfaceBase
Fleet (fims)
FleetInterface
FleetInterfaceBase
+
fims_log (fims)
FIMSObject (fims_model_object)
FIMSRcppInterfaceBase
Fleet (fims_popdy)
FleetInterface
FleetInterfaceBase
G
-
GrowthBase (fims)
GrowthInterfaceBase
+
GrowthBase (fims_popdy)
GrowthInterfaceBase
I
-
IndexDataInterface
Information (fims)
+
IndexDataInterface
Information (fims_info)
J
JsonParser
JsonValue
L
-
LogisticMaturity (fims)
LogisticMaturityInterface
LogisticSelectivity (fims)
LogisticSelectivityInterface
+
LogisticMaturity (fims_popdy)
LogisticMaturityInterface
LogisticSelectivity (fims_popdy)
LogisticSelectivityInterface
M
-
MaturityBase (fims)
MaturityInterfaceBase
Model (fims)
+
MaturityBase (fims_popdy)
MaturityInterfaceBase
Model (fims_model)
N
NLLInterfaceBase
P
-
Parameter
Population (fims)
PopulationInterface
PopulationInterfaceBase
+
Parameter
Population (fims_popdy)
PopulationInterface
PopulationInterfaceBase
R
-
RecruitmentBase (fims)
RecruitmentInterfaceBase
+
RecruitmentBase (fims_popdy)
RecruitmentInterfaceBase
S
-
SelectivityBase (fims)
SelectivityInterfaceBase
SRBevertonHolt (fims)
Subpopulation (fims)
+
SelectivityBase (fims_popdy)
SelectivityInterfaceBase
SRBevertonHolt (fims_popdy)
Subpopulation (fims_popdy)
diff --git a/docs/classfims__info_1_1Information-members.html b/docs/classfims__info_1_1Information-members.html new file mode 100644 index 0000000..f8289fb --- /dev/null +++ b/docs/classfims__info_1_1Information-members.html @@ -0,0 +1,126 @@ + + + + + + + +FIMS: Member List + + + + + + + + + + + +
+
+ + + + + + +
+
FIMS +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
fims_info::Information< Type > Member List
+
+
+ +

This is the complete list of members for fims_info::Information< Type >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CreateModel()fims_info::Information< Type >inline
data_iterator typedeffims_info::Information< Type >
data_objectsfims_info::Information< Type >
distribution_modelsfims_info::Information< Type >
distribution_models_iterator typedeffims_info::Information< Type >
fims_informationfims_info::Information< Type >static
fixed_effects_parametersfims_info::Information< Type >
fleet_iterator typedeffims_info::Information< Type >
fleetsfims_info::Information< Type >
GetFixedEffectsParameters()fims_info::Information< Type >inline
GetInstance()fims_info::Information< Type >inlinestatic
GetNages() constfims_info::Information< Type >inline
GetNseasons() constfims_info::Information< Type >inline
GetNyears() constfims_info::Information< Type >inline
GetParameters()fims_info::Information< Type >inline
GetRandomEffectsParameters()fims_info::Information< Type >inline
growth_modelsfims_info::Information< Type >
growth_models_iterator typedeffims_info::Information< Type >
Information() (defined in fims_info::Information< Type >)fims_info::Information< Type >inline
maturity_modelsfims_info::Information< Type >
maturity_models_iterator typedeffims_info::Information< Type >
nagesfims_info::Information< Type >
nseasonsfims_info::Information< Type >
nyearsfims_info::Information< Type >
parametersfims_info::Information< Type >
population_iterator typedeffims_info::Information< Type >
populationsfims_info::Information< Type >
random_effects_parametersfims_info::Information< Type >
recruitment_modelsfims_info::Information< Type >
recruitment_models_iterator typedeffims_info::Information< Type >
RegisterParameter(Type &p)fims_info::Information< Type >inline
RegisterRandomEffect(Type &re)fims_info::Information< Type >inline
selectivity_modelsfims_info::Information< Type >
selectivity_models_iterator typedeffims_info::Information< Type >
SetNages(size_t nages)fims_info::Information< Type >inline
SetNseasons(size_t nseasons)fims_info::Information< Type >inline
SetNyears(size_t nyears)fims_info::Information< Type >inline
~Information() (defined in fims_info::Information< Type >)fims_info::Information< Type >inlinevirtual
+ + + + diff --git a/docs/classfims__info_1_1Information.html b/docs/classfims__info_1_1Information.html new file mode 100644 index 0000000..5e28fd8 --- /dev/null +++ b/docs/classfims__info_1_1Information.html @@ -0,0 +1,1022 @@ + + + + + + + +FIMS: fims_info::Information< Type > Class Template Reference + + + + + + + + + + + +
+
+ + + + + + +
+
FIMS +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+ +
+
fims_info::Information< Type > Class Template Reference
+
+
+ +

Stores FIMS model information and creates model. Contains all objects and data pre-model construction. + More...

+ +

#include <information.hpp>

+ + + + + + + + + + + + + + + + + + +

+Public Types

typedef std::map< uint32_t, std::shared_ptr< fims_data_object::DataObject< Type > > >::iterator data_iterator
 
typedef std::map< uint32_t, std::shared_ptr< fims_popdy::RecruitmentBase< Type > > >::iterator recruitment_models_iterator
 
typedef std::map< uint32_t, std::shared_ptr< fims_popdy::SelectivityBase< Type > > >::iterator selectivity_models_iterator
 
typedef std::map< uint32_t, std::shared_ptr< fims_popdy::GrowthBase< Type > > >::iterator growth_models_iterator
 
typedef std::map< uint32_t, std::shared_ptr< fims_popdy::MaturityBase< Type > > >::iterator maturity_models_iterator
 
typedef std::map< uint32_t, std::shared_ptr< fims_popdy::Fleet< Type > > >::iterator fleet_iterator
 
typedef std::map< uint32_t, std::shared_ptr< fims_popdy::Population< Type > > >::iterator population_iterator
 
typedef std::map< uint32_t, std::shared_ptr< fims_distributions::DistributionsBase< Type > > >::iterator distribution_models_iterator
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

void RegisterParameter (Type &p)
 
void RegisterRandomEffect (Type &re)
 
bool CreateModel ()
 
size_t GetNages () const
 Get the Nages object. More...
 
void SetNages (size_t nages)
 Set the Nages object. More...
 
size_t GetNseasons () const
 Get the Nseasons object. More...
 
void SetNseasons (size_t nseasons)
 Set the Nseasons object. More...
 
size_t GetNyears () const
 Get the Nyears object. More...
 
void SetNyears (size_t nyears)
 Set the Nyears object. More...
 
std::vector< Type * > & GetParameters ()
 Get the Parameters object. More...
 
std::vector< Type * > & GetFixedEffectsParameters ()
 Get the Fixed Effects Parameters object. More...
 
std::vector< Type * > & GetRandomEffectsParameters ()
 Get the Random Effects Parameters object. More...
 
+ + + +

+Static Public Member Functions

static std::shared_ptr< Information< Type > > GetInstance ()
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

size_t nyears
 
size_t nseasons = 1
 
size_t nages
 
std::vector< Type * > parameters
 
std::vector< Type * > random_effects_parameters
 
std::vector< Type * > fixed_effects_parameters
 
std::map< uint32_t, std::shared_ptr< fims_data_object::DataObject< Type > > > data_objects
 
std::map< uint32_t, std::shared_ptr< fims_popdy::RecruitmentBase< Type > > > recruitment_models
 
std::map< uint32_t, std::shared_ptr< fims_popdy::SelectivityBase< Type > > > selectivity_models
 
std::map< uint32_t, std::shared_ptr< fims_popdy::GrowthBase< Type > > > growth_models
 
std::map< uint32_t, std::shared_ptr< fims_popdy::MaturityBase< Type > > > maturity_models
 
std::map< uint32_t, std::shared_ptr< fims_popdy::Fleet< Type > > > fleets
 
std::map< uint32_t, std::shared_ptr< fims_popdy::Population< Type > > > populations
 
std::map< uint32_t, std::shared_ptr< fims_distributions::DistributionsBase< Type > > > distribution_models
 
+ + + +

+Static Public Attributes

static std::shared_ptr< Information< Type > > fims_information
 
+

Detailed Description

+

template<typename Type>
+class fims_info::Information< Type >

+ +

Stores FIMS model information and creates model. Contains all objects and data pre-model construction.

+

Member Typedef Documentation

+ +

◆ data_iterator

+ +
+
+
+template<typename Type >
+ + + + +
typedef std::map<uint32_t, std::shared_ptr<fims_data_object::DataObject<Type> > >::iterator fims_info::Information< Type >::data_iterator
+
+

iterator for the data objects

+ +
+
+ +

◆ distribution_models_iterator

+ +
+
+
+template<typename Type >
+ + + + +
typedef std::map<uint32_t, std::shared_ptr<fims_distributions::DistributionsBase<Type> > >::iterator fims_info::Information< Type >::distribution_models_iterator
+
+

iterator for distribution objects>

+ +
+
+ +

◆ fleet_iterator

+ +
+
+
+template<typename Type >
+ + + + +
typedef std::map<uint32_t, std::shared_ptr<fims_popdy::Fleet<Type> > >::iterator fims_info::Information< Type >::fleet_iterator
+
+

iterator for fleet objects>

+ +
+
+ +

◆ growth_models_iterator

+ +
+
+
+template<typename Type >
+ + + + +
typedef std::map<uint32_t, std::shared_ptr<fims_popdy::GrowthBase<Type> > >::iterator fims_info::Information< Type >::growth_models_iterator
+
+

iterator for growth objects>

+ +
+
+ +

◆ maturity_models_iterator

+ +
+
+
+template<typename Type >
+ + + + +
typedef std::map<uint32_t, std::shared_ptr<fims_popdy::MaturityBase<Type> > >::iterator fims_info::Information< Type >::maturity_models_iterator
+
+

iterator for maturity objects>

+ +
+
+ +

◆ population_iterator

+ +
+
+
+template<typename Type >
+ + + + +
typedef std::map<uint32_t, std::shared_ptr<fims_popdy::Population<Type> > >::iterator fims_info::Information< Type >::population_iterator
+
+

iterator for population objects>

+ +
+
+ +

◆ recruitment_models_iterator

+ +
+
+
+template<typename Type >
+ + + + +
typedef std::map<uint32_t, std::shared_ptr<fims_popdy::RecruitmentBase<Type> > >::iterator fims_info::Information< Type >::recruitment_models_iterator
+
+

iterator for recruitment objects>

+ +
+
+ +

◆ selectivity_models_iterator

+ +
+
+
+template<typename Type >
+ + + + +
typedef std::map<uint32_t, std::shared_ptr<fims_popdy::SelectivityBase<Type> > >::iterator fims_info::Information< Type >::selectivity_models_iterator
+
+

iterator for selectivity objects>

+ +
+
+

Member Function Documentation

+ +

◆ CreateModel()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + +
bool fims_info::Information< Type >::CreateModel ()
+
+inline
+
+

Create the generalized stock assessment model that will evaluate the objective function. Does error checking to make sure the program has all necessary components for the model and that they're in the right dimensions.

+
Returns
+ +
+
+ +

◆ GetFixedEffectsParameters()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + +
std::vector<Type*>& fims_info::Information< Type >::GetFixedEffectsParameters ()
+
+inline
+
+ +

Get the Fixed Effects Parameters object.

+
Returns
std::vector<Type*>&
+ +
+
+ +

◆ GetInstance()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + +
static std::shared_ptr<Information<Type> > fims_info::Information< Type >::GetInstance ()
+
+inlinestatic
+
+

Returns a single Information object for type T.

+
Returns
singleton for type T
+ +
+
+ +

◆ GetNages()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + +
size_t fims_info::Information< Type >::GetNages () const
+
+inline
+
+ +

Get the Nages object.

+
Returns
size_t
+ +
+
+ +

◆ GetNseasons()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + +
size_t fims_info::Information< Type >::GetNseasons () const
+
+inline
+
+ +

Get the Nseasons object.

+
Returns
size_t
+ +
+
+ +

◆ GetNyears()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + +
size_t fims_info::Information< Type >::GetNyears () const
+
+inline
+
+ +

Get the Nyears object.

+
Returns
size_t
+ +
+
+ +

◆ GetParameters()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + +
std::vector<Type*>& fims_info::Information< Type >::GetParameters ()
+
+inline
+
+ +

Get the Parameters object.

+
Returns
std::vector<Type*>&
+ +
+
+ +

◆ GetRandomEffectsParameters()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + +
std::vector<Type*>& fims_info::Information< Type >::GetRandomEffectsParameters ()
+
+inline
+
+ +

Get the Random Effects Parameters object.

+
Returns
std::vector<Type*>&
+ +
+
+ +

◆ RegisterParameter()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + + +
void fims_info::Information< Type >::RegisterParameter (Type & p)
+
+inline
+
+

Register a parameter as estimable.

+
Parameters
+ + +
p
+
+
+ +
+
+ +

◆ RegisterRandomEffect()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + + +
void fims_info::Information< Type >::RegisterRandomEffect (Type & re)
+
+inline
+
+

Register a random effect as estimable.

+
Parameters
+ + +
re
+
+
+ +
+
+ +

◆ SetNages()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + + +
void fims_info::Information< Type >::SetNages (size_t nages)
+
+inline
+
+ +

Set the Nages object.

+
Parameters
+ + +
nages
+
+
+ +
+
+ +

◆ SetNseasons()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + + +
void fims_info::Information< Type >::SetNseasons (size_t nseasons)
+
+inline
+
+ +

Set the Nseasons object.

+
Parameters
+ + +
nseasons
+
+
+ +
+
+ +

◆ SetNyears()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + + +
void fims_info::Information< Type >::SetNyears (size_t nyears)
+
+inline
+
+ +

Set the Nyears object.

+
Parameters
+ + +
nyears
+
+
+ +
+
+

Member Data Documentation

+ +

◆ data_objects

+ +
+
+
+template<typename Type >
+ + + + +
std::map<uint32_t, std::shared_ptr<fims_data_object::DataObject<Type> > > fims_info::Information< Type >::data_objects
+
+

map that holds data objects >

+ +
+
+ +

◆ distribution_models

+ +
+
+
+template<typename Type >
+ + + + +
std::map<uint32_t, std::shared_ptr<fims_distributions::DistributionsBase<Type> > > fims_info::Information< Type >::distribution_models
+
+

hash map to link each object to its shared location in memory

+ +
+
+ +

◆ fims_information

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + +
std::shared_ptr< Information< Type > > fims_info::Information< Type >::fims_information
+
+static
+
+Initial value:
=
+
nullptr
+

singleton instance >

+ +
+
+ +

◆ fixed_effects_parameters

+ +
+
+
+template<typename Type >
+ + + + +
std::vector<Type*> fims_info::Information< Type >::fixed_effects_parameters
+
+

list of all fixed effects parameters >

+ +
+
+ +

◆ fleets

+ +
+
+
+template<typename Type >
+ + + + +
std::map<uint32_t, std::shared_ptr<fims_popdy::Fleet<Type> > > fims_info::Information< Type >::fleets
+
+

hash map to link each object to its shared location in memory

+ +
+
+ +

◆ growth_models

+ +
+
+
+template<typename Type >
+ + + + +
std::map<uint32_t, std::shared_ptr<fims_popdy::GrowthBase<Type> > > fims_info::Information< Type >::growth_models
+
+

hash map to link each object to its shared location in memory

+ +
+
+ +

◆ maturity_models

+ +
+
+
+template<typename Type >
+ + + + +
std::map<uint32_t, std::shared_ptr<fims_popdy::MaturityBase<Type> > > fims_info::Information< Type >::maturity_models
+
+

hash map to link each object to its shared location in memory

+ +
+
+ +

◆ nages

+ +
+
+
+template<typename Type >
+ + + + +
size_t fims_info::Information< Type >::nages
+
+

number of ages>

+ +
+
+ +

◆ nseasons

+ +
+
+
+template<typename Type >
+ + + + +
size_t fims_info::Information< Type >::nseasons = 1
+
+

number of seasons >

+ +
+
+ +

◆ nyears

+ +
+
+
+template<typename Type >
+ + + + +
size_t fims_info::Information< Type >::nyears
+
+

number of years >

+ +
+
+ +

◆ parameters

+ +
+
+
+template<typename Type >
+ + + + +
std::vector<Type*> fims_info::Information< Type >::parameters
+
+

list of all estimated parameters >

+ +
+
+ +

◆ populations

+ +
+
+
+template<typename Type >
+ + + + +
std::map<uint32_t, std::shared_ptr<fims_popdy::Population<Type> > > fims_info::Information< Type >::populations
+
+

hash map to link each object to its shared location in memory

+ +
+
+ +

◆ random_effects_parameters

+ +
+
+
+template<typename Type >
+ + + + +
std::vector<Type*> fims_info::Information< Type >::random_effects_parameters
+
+

list of all random effects parameters >

+ +
+
+ +

◆ recruitment_models

+ +
+
+
+template<typename Type >
+ + + + +
std::map<uint32_t, std::shared_ptr<fims_popdy::RecruitmentBase<Type> > > fims_info::Information< Type >::recruitment_models
+
+

hash map to link each object to its shared location in memory

+ +
+
+ +

◆ selectivity_models

+ +
+
+
+template<typename Type >
+ + + + +
std::map<uint32_t, std::shared_ptr<fims_popdy::SelectivityBase<Type> > > fims_info::Information< Type >::selectivity_models
+
+

hash map to link each object to its shared location in memory

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/docs/classfims__model_1_1Model-members.html b/docs/classfims__model_1_1Model-members.html new file mode 100644 index 0000000..1a9d1fb --- /dev/null +++ b/docs/classfims__model_1_1Model-members.html @@ -0,0 +1,93 @@ + + + + + + + +FIMS: Member List + + + + + + + + + + + +
+
+ + + + + + +
+
FIMS +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
fims_model::Model< Type > Member List
+
+
+ +

This is the complete list of members for fims_model::Model< Type >, including all inherited members.

+ + + + + + +
Evaluate()fims_model::Model< Type >inline
fims_informationfims_model::Model< Type >
fims_modelfims_model::Model< Type >static
GetInstance()fims_model::Model< Type >inlinestatic
~Model() (defined in fims_model::Model< Type >)fims_model::Model< Type >inlinevirtual
+ + + + diff --git a/docs/classfims__model_1_1Model.html b/docs/classfims__model_1_1Model.html new file mode 100644 index 0000000..d6dffdb --- /dev/null +++ b/docs/classfims__model_1_1Model.html @@ -0,0 +1,202 @@ + + + + + + + +FIMS: fims_model::Model< Type > Class Template Reference + + + + + + + + + + + +
+
+ + + + + + +
+
FIMS +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+ +
+
fims_model::Model< Type > Class Template Reference
+
+
+ +

Model class. FIMS objective function. + More...

+ +

#include <model.hpp>

+ + + + + +

+Public Member Functions

+const Type Evaluate ()
 Evaluate. Calculates the joint negative log-likelihood function.
 
+ + + +

+Static Public Member Functions

static std::shared_ptr< Model< Type > > GetInstance ()
 
+ + + +

+Public Attributes

std::shared_ptr< fims_info::Information< Type > > fims_information
 
+ + + +

+Static Public Attributes

static std::shared_ptr< Model< Type > > fims_model
 
+

Detailed Description

+

template<typename Type>
+class fims_model::Model< Type >

+ +

Model class. FIMS objective function.

+

Member Function Documentation

+ +

◆ GetInstance()

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + + + + +
static std::shared_ptr<Model<Type> > fims_model::Model< Type >::GetInstance ()
+
+inlinestatic
+
+

Returns a single Information object for type Type.

+
Returns
singleton for type Type
+ +
+
+

Member Data Documentation

+ +

◆ fims_information

+ +
+
+
+template<typename Type >
+ + + + +
std::shared_ptr<fims_info::Information<Type> > fims_model::Model< Type >::fims_information
+
+

Create a shared fims_information as a pointer to Information

+ +
+
+ +

◆ fims_model

+ +
+
+
+template<typename Type >
+ + + + + +
+ + + + +
std::shared_ptr< Model< Type > > fims_model::Model< Type >::fims_model
+
+static
+
+Initial value:
=
+
nullptr
+

Create a shared fims_model as a pointer to Model

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/docs/classfims__popdy_1_1Subpopulation.html b/docs/classfims__popdy_1_1Subpopulation.html new file mode 100644 index 0000000..730d1e4 --- /dev/null +++ b/docs/classfims__popdy_1_1Subpopulation.html @@ -0,0 +1,95 @@ + + + + + + + +FIMS: fims_popdy::Subpopulation< Type > Class Template Reference + + + + + + + + + + + +
+
+ + + + + + +
+
FIMS +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
fims_popdy::Subpopulation< Type > Class Template Reference
+
+
+ +

#include <subpopulation.hpp>

+

Detailed Description

+

template<typename Type>
+class fims_popdy::Subpopulation< Type >

+ +

Subpopulation class. This class represents a generic partition of a population (eg., sex, area).

+

The documentation for this class was generated from the following file: +
+ + + + diff --git a/docs/data__object_8hpp_source.html b/docs/data__object_8hpp_source.html index ed3d230..160a454 100644 --- a/docs/data__object_8hpp_source.html +++ b/docs/data__object_8hpp_source.html @@ -115,126 +115,126 @@
37 
38 #include "model_object.hpp"
39 
-
40 namespace fims {
+
40 namespace fims_data_object {
41 
45 template <typename Type>
-
46 struct DataObject : public fims::FIMSObject<Type> {
-
47  static uint32_t id_g;
-
48  std::vector<Type> data;
-
49  size_t dimensions;
-
50  size_t imax;
-
51  size_t jmax;
-
52  size_t kmax;
-
53  size_t lmax;
-
58  DataObject(size_t imax) : dimensions(1), imax(imax) {
-
59  data.resize(imax);
+ +
47  static uint32_t id_g;
+
48  std::vector<Type> data;
+
49  size_t dimensions;
+
50  size_t imax;
+
51  size_t jmax;
+
52  size_t kmax;
+
53  size_t lmax;
+
58  DataObject(size_t imax) : dimensions(1), imax(imax) {
+
59  data.resize(imax);
60 
-
61  this->id = DataObject<Type>::id_g++;
+
61  this->id = DataObject<Type>::id_g++;
62  }
63 
-
67  DataObject(size_t imax, size_t jmax) : dimensions(2), imax(imax), jmax(jmax) {
-
68  data.resize(imax * jmax);
-
69  this->id = DataObject<Type>::id_g++;
+
67  DataObject(size_t imax, size_t jmax) : dimensions(2), imax(imax), jmax(jmax) {
+
68  data.resize(imax * jmax);
+
69  this->id = DataObject<Type>::id_g++;
70  }
71 
-
75  DataObject(size_t imax, size_t jmax, size_t kmax)
-
76  : dimensions(3), imax(imax), jmax(jmax), kmax(kmax) {
-
77  data.resize(imax * jmax * kmax);
-
78  this->id = DataObject<Type>::id_g++;
+
75  DataObject(size_t imax, size_t jmax, size_t kmax)
+
76  : dimensions(3), imax(imax), jmax(jmax), kmax(kmax) {
+
77  data.resize(imax * jmax * kmax);
+
78  this->id = DataObject<Type>::id_g++;
79  }
80 
-
84  DataObject(size_t imax, size_t jmax, size_t kmax, size_t lmax)
-
85  : dimensions(4), imax(imax), jmax(jmax), kmax(kmax), lmax(lmax) {
-
86  data.resize(imax * jmax * kmax * lmax);
-
87  this->id = DataObject<Type>::id_g++;
+
84  DataObject(size_t imax, size_t jmax, size_t kmax, size_t lmax)
+
85  : dimensions(4), imax(imax), jmax(jmax), kmax(kmax), lmax(lmax) {
+
86  data.resize(imax * jmax * kmax * lmax);
+
87  this->id = DataObject<Type>::id_g++;
88  }
89 
-
95  inline Type operator()(size_t i) { return data[i]; }
+
95  inline Type operator()(size_t i) { return data[i]; }
96 
-
103  inline Type& at(size_t i) {
+
103  inline Type& at(size_t i) {
104  if (i >= this->data.size()) {
105  throw std::overflow_error("DataObject error:i index out of bounds");
106  }
-
107  return data[i];
+
107  return data[i];
108  }
109 
-
116  inline const Type operator()(size_t i, size_t j) {
-
117  return data[i * jmax + j];
+
116  inline const Type operator()(size_t i, size_t j) {
+
117  return data[i * jmax + j];
118  }
119 
-
127  inline Type& at(size_t i, size_t j) {
-
128  if ((i * jmax + j) >= this->data.size()) {
+
127  inline Type& at(size_t i, size_t j) {
+
128  if ((i * jmax + j) >= this->data.size()) {
129  throw std::overflow_error("DataObject error: index out of bounds");
130  }
-
131  return data[i * jmax + j];
+
131  return data[i * jmax + j];
132  }
133 
-
141  inline const Type operator()(size_t i, size_t j, size_t k) {
-
142  return data[i * jmax * kmax + j * kmax + k];
+
141  inline const Type operator()(size_t i, size_t j, size_t k) {
+
142  return data[i * jmax * kmax + j * kmax + k];
143  }
144 
-
153  inline Type& at(size_t i, size_t j, size_t k) {
-
154  if ((i * jmax * kmax + j * kmax + k) >= this->data.size()) {
+
153  inline Type& at(size_t i, size_t j, size_t k) {
+
154  if ((i * jmax * kmax + j * kmax + k) >= this->data.size()) {
155  throw std::overflow_error("DataObject error: index out of bounds");
156  }
-
157  return data[i * jmax * kmax + j * kmax + k];
+
157  return data[i * jmax * kmax + j * kmax + k];
158  }
159 
-
168  inline const Type operator()(size_t i, size_t j, size_t k, size_t l) {
-
169  return data[i * jmax * kmax * lmax + j * kmax * lmax + k * lmax + l];
+
168  inline const Type operator()(size_t i, size_t j, size_t k, size_t l) {
+
169  return data[i * jmax * kmax * lmax + j * kmax * lmax + k * lmax + l];
170  }
171 
-
181  inline Type& at(size_t i, size_t j, size_t k, size_t l) {
-
182  if ((i * jmax * kmax * lmax + j * kmax * lmax + k * lmax + l) >=
+
181  inline Type& at(size_t i, size_t j, size_t k, size_t l) {
+
182  if ((i * jmax * kmax * lmax + j * kmax * lmax + k * lmax + l) >=
183  this->data.size()) {
184  throw std::overflow_error("DataObject error: index out of bounds");
185  }
-
186  return data[i * jmax * kmax * lmax + j * kmax * lmax + k * lmax + l];
+
186  return data[i * jmax * kmax * lmax + j * kmax * lmax + k * lmax + l];
187  }
188 
-
194  size_t get_dimensions() const { return dimensions; }
+
194  size_t get_dimensions() const { return dimensions; }
195 
-
201  size_t get_imax() const { return imax; }
+
201  size_t get_imax() const { return imax; }
202 
-
208  size_t get_jmax() const { return jmax; }
+
208  size_t get_jmax() const { return jmax; }
209 
-
215  size_t get_kmax() const { return kmax; }
+
215  size_t get_kmax() const { return kmax; }
216 
-
222  size_t get_lmax() const { return lmax; }
+
222  size_t get_lmax() const { return lmax; }
223 };
224 
225 template <typename Type>
-
226 uint32_t DataObject<Type>::id_g = 0;
+
226 uint32_t DataObject<Type>::id_g = 0;
227 
-
228 } // namespace fims
+
228 } // namespace fims_data_object
229 
230 #endif
-
Definition: data_object.hpp:46
-
DataObject(size_t imax, size_t jmax, size_t kmax, size_t lmax)
Definition: data_object.hpp:84
-
static uint32_t id_g
Definition: data_object.hpp:47
-
const Type operator()(size_t i, size_t j, size_t k)
Definition: data_object.hpp:141
-
DataObject(size_t imax, size_t jmax, size_t kmax)
Definition: data_object.hpp:75
-
Type & at(size_t i, size_t j)
Definition: data_object.hpp:127
-
size_t get_kmax() const
Get the kmax object.
Definition: data_object.hpp:215
-
Type & at(size_t i, size_t j, size_t k, size_t l)
Definition: data_object.hpp:181
-
size_t get_imax() const
Get the imax object.
Definition: data_object.hpp:201
-
Type & at(size_t i, size_t j, size_t k)
Definition: data_object.hpp:153
-
size_t lmax
Definition: data_object.hpp:53
-
size_t imax
Definition: data_object.hpp:50
-
DataObject(size_t imax, size_t jmax)
Definition: data_object.hpp:67
-
size_t dimensions
Definition: data_object.hpp:49
-
size_t get_dimensions() const
Get the dimensions object.
Definition: data_object.hpp:194
-
std::vector< Type > data
Definition: data_object.hpp:48
-
DataObject(size_t imax)
Definition: data_object.hpp:58
-
size_t get_jmax() const
Get the jmax object.
Definition: data_object.hpp:208
-
Type operator()(size_t i)
Definition: data_object.hpp:95
-
size_t jmax
Definition: data_object.hpp:51
-
size_t get_lmax() const
Get the lmax object.
Definition: data_object.hpp:222
-
Type & at(size_t i)
Definition: data_object.hpp:103
-
const Type operator()(size_t i, size_t j)
Definition: data_object.hpp:116
-
size_t kmax
Definition: data_object.hpp:52
-
const Type operator()(size_t i, size_t j, size_t k, size_t l)
Definition: data_object.hpp:168
-
FIMSObject struct that defines member types and returns the unique id.
Definition: model_object.hpp:25
+
Definition: data_object.hpp:46
+
size_t get_dimensions() const
Get the dimensions object.
Definition: data_object.hpp:194
+
size_t lmax
Definition: data_object.hpp:53
+
Type operator()(size_t i)
Definition: data_object.hpp:95
+
size_t get_imax() const
Get the imax object.
Definition: data_object.hpp:201
+
Type & at(size_t i)
Definition: data_object.hpp:103
+
Type & at(size_t i, size_t j)
Definition: data_object.hpp:127
+
size_t kmax
Definition: data_object.hpp:52
+
const Type operator()(size_t i, size_t j)
Definition: data_object.hpp:116
+
DataObject(size_t imax, size_t jmax, size_t kmax)
Definition: data_object.hpp:75
+
std::vector< Type > data
Definition: data_object.hpp:48
+
const Type operator()(size_t i, size_t j, size_t k)
Definition: data_object.hpp:141
+
size_t get_jmax() const
Get the jmax object.
Definition: data_object.hpp:208
+
size_t get_lmax() const
Get the lmax object.
Definition: data_object.hpp:222
+
DataObject(size_t imax)
Definition: data_object.hpp:58
+
size_t imax
Definition: data_object.hpp:50
+
DataObject(size_t imax, size_t jmax, size_t kmax, size_t lmax)
Definition: data_object.hpp:84
+
DataObject(size_t imax, size_t jmax)
Definition: data_object.hpp:67
+
const Type operator()(size_t i, size_t j, size_t k, size_t l)
Definition: data_object.hpp:168
+
Type & at(size_t i, size_t j, size_t k)
Definition: data_object.hpp:153
+
size_t get_kmax() const
Get the kmax object.
Definition: data_object.hpp:215
+
size_t dimensions
Definition: data_object.hpp:49
+
Type & at(size_t i, size_t j, size_t k, size_t l)
Definition: data_object.hpp:181
+
size_t jmax
Definition: data_object.hpp:51
+
static uint32_t id_g
Definition: data_object.hpp:47
+
FIMSObject struct that defines member types and returns the unique id.
Definition: model_object.hpp:25