From 7c48011458b60a011cccf1ab6ef310b3023b9b3e Mon Sep 17 00:00:00 2001 From: Christine Stawitz Date: Mon, 9 Dec 2024 22:22:59 +0000 Subject: [PATCH] Docs: run Doxygen --- docs/annotated.html | 36 +- docs/classAgeCompDataInterface-members.html | 9 +- docs/classAgeCompDataInterface.html | 12 - ...ertonHoltRecruitmentInterface-members.html | 18 +- ...classBevertonHoltRecruitmentInterface.html | 109 +- docs/classDataInterfaceBase-members.html | 5 +- docs/classDataInterfaceBase.html | 19 +- docs/classDataInterfaceBase.png | Bin 1607 -> 1328 bytes ...assDistributionsInterfaceBase-members.html | 16 +- docs/classDistributionsInterfaceBase.html | 186 +-- ...sDlnormDistributionsInterface-members.html | 27 +- docs/classDlnormDistributionsInterface.html | 183 +-- ...ultinomDistributionsInterface-members.html | 26 +- .../classDmultinomDistributionsInterface.html | 187 +-- ...ssDnormDistributionsInterface-members.html | 27 +- docs/classDnormDistributionsInterface.html | 180 +-- ...eLogisticSelectivityInterface-members.html | 15 +- ...assDoubleLogisticSelectivityInterface.html | 51 +- docs/classEWAAGrowthInterface-members.html | 9 +- docs/classEWAAGrowthInterface.html | 11 - docs/classFIMSRcppInterfaceBase-members.html | 3 - docs/classFIMSRcppInterfaceBase.html | 35 +- docs/classFIMSRcppInterfaceBase.png | Bin 4124 -> 4125 bytes docs/classFleetInterface-members.html | 49 +- docs/classFleetInterface.html | 298 ++-- docs/classFleetInterfaceBase-members.html | 5 +- docs/classFleetInterfaceBase.html | 11 - docs/classGrowthInterfaceBase-members.html | 5 +- docs/classGrowthInterfaceBase.html | 11 - docs/classIndexDataInterface-members.html | 9 +- docs/classIndexDataInterface.html | 12 - ...lassLogisticMaturityInterface-members.html | 11 +- docs/classLogisticMaturityInterface.html | 31 +- ...sLogisticSelectivityInterface-members.html | 11 +- docs/classLogisticSelectivityInterface.html | 31 +- docs/classMaturityInterfaceBase-members.html | 5 +- docs/classMaturityInterfaceBase.html | 11 - docs/classParameter-members.html | 10 +- docs/classParameter.html | 110 +- docs/classPopulationInterface-members.html | 43 +- docs/classPopulationInterface.html | 191 +-- .../classPopulationInterfaceBase-members.html | 5 +- docs/classPopulationInterfaceBase.html | 11 - ...classRecruitmentInterfaceBase-members.html | 16 +- docs/classRecruitmentInterfaceBase.html | 47 +- ...classSelectivityInterfaceBase-members.html | 5 +- docs/classSelectivityInterfaceBase.html | 11 - docs/classes.html | 14 +- docs/classfims_1_1Vector-members.html | 61 +- docs/classfims_1_1Vector.html | 40 - ...lassfims__info_1_1Information-members.html | 27 +- docs/classfims__info_1_1Information.html | 212 +-- docs/data__object_8hpp_source.html | 293 ++-- docs/def_8hpp.html | 270 ++-- docs/def_8hpp_source.html | 595 +------- .../dir_1678aebb33bcc66091bafb58a771ebcc.html | 12 +- .../dir_18d7dde31df7be29ff6228ae177c21fd.html | 6 - .../dir_1e91ec27400c96ae80a632ccfbdcb525.html | 6 - .../dir_2e8bd4230d2fd1bf70799e5d0f1b5e4a.html | 10 - .../dir_33e0024dd00b9ce79198d783b7c2b2ff.html | 6 - .../dir_37bdea9fff2fdc698227d6fda51b8784.html | 6 - .../dir_393b99a6ba686a4e9d8893eeed28f446.html | 10 - .../dir_4061a19dc6288bb60d0da2c821ead74b.html | 34 - .../dir_4b06d3d22876e8a9de795c0a16cf36db.html | 4 - .../dir_6315be8a572b87c2bcef063caabfa549.html | 9 - .../dir_78bab4de0b210d1f38696a0ee50fd3de.html | 9 - .../dir_825acd3dee85b944c8adc67f8f95c8cb.html | 15 - .../dir_cf9876eeb8486b9ec32ec52ea9e00fbd.html | 6 - .../dir_dc730c142f9595d227ed6282d167d643.html | 1 - .../dir_e37de6988527f326a4d5f60f689d8e02.html | 6 - .../dir_ec7d59b9ad424ffe7f0c26e992e91d44.html | 10 - docs/distributions_8hpp_source.html | 36 +- docs/double__logistic_8hpp_source.html | 92 +- docs/ewaa_8hpp_source.html | 44 +- docs/files.html | 78 +- docs/fims__json_8hpp.html | 60 +- docs/fims__json_8hpp_source.html | 780 +++++----- docs/fims__math_8hpp.html | 75 +- docs/fims__math_8hpp_source.html | 268 ++-- docs/fims__vector_8hpp_source.html | 626 +++----- docs/fleet_8hpp.html | 17 +- docs/fleet_8hpp_source.html | 458 +++--- docs/functions.html | 6 +- docs/functions_c.html | 9 +- docs/functions_d.html | 55 +- docs/functions_e.html | 80 +- docs/functions_f.html | 45 +- docs/functions_func.html | 434 +++++- docs/functions_g.html | 59 +- docs/functions_i.html | 50 +- docs/functions_j.html | 2 +- docs/functions_k.html | 6 - docs/functions_l.html | 68 +- docs/functions_m.html | 10 +- docs/functions_n.html | 13 - docs/functions_o.html | 22 - docs/functions_p.html | 24 +- docs/functions_q.html | 2 +- docs/functions_r.html | 17 +- docs/functions_s.html | 74 +- docs/functions_type.html | 12 +- docs/functions_u.html | 3 - docs/functions_v.html | 9 +- docs/functions_vars.html | 509 ++++++- docs/functions_w.html | 14 +- docs/functions_x.html | 7 +- docs/functions_y.html | 1 - docs/functions_~.html | 15 - docs/globals.html | 218 +-- docs/globals_func.html | 150 +- docs/growth_8hpp_source.html | 28 +- docs/growth__base_8hpp_source.html | 74 +- docs/hierarchy.html | 67 +- docs/index.html | 8 +- docs/information_8hpp.html | 21 +- docs/information_8hpp_source.html | 990 ++++++------ docs/init_8hpp_source.html | 97 +- docs/interface_8hpp_source.html | 112 +- ...urity_2functors_2logistic_8hpp_source.html | 75 +- docs/maturity_8hpp_source.html | 29 +- docs/maturity__base_8hpp_source.html | 83 +- docs/menudata.js | 114 +- docs/model_8hpp_source.html | 503 +++---- docs/model__object_8hpp_source.html | 88 +- docs/population_8hpp_source.html | 1155 +++++++------- docs/rcpp__data_8hpp_source.html | 292 ++-- docs/rcpp__fleet_8hpp_source.html | 529 ++----- docs/rcpp__growth_8hpp_source.html | 109 +- docs/rcpp__interface_8hpp_source.html | 1338 ++++++----------- docs/rcpp__interface__base_8hpp_source.html | 315 +--- docs/rcpp__maturity_8hpp_source.html | 338 ++--- .../rcpp__natural__mortality_8hpp_source.html | 18 +- docs/rcpp__population_8hpp_source.html | 462 ++---- docs/rcpp__recruitment_8hpp_source.html | 445 +++--- docs/rcpp__selectivity_8hpp_source.html | 683 +++------ docs/recruitment_8hpp_source.html | 29 +- docs/recruitment__base_8hpp.html | 14 +- docs/recruitment__base_8hpp_source.html | 147 +- docs/search/all_0.js | 14 +- docs/search/all_1.js | 18 +- docs/search/all_10.js | 20 +- docs/search/all_11.js | 67 +- docs/search/all_12.js | 48 +- docs/search/all_13.js | 8 +- docs/search/all_14.js | 8 +- docs/search/all_15.js | 9 +- docs/search/all_16.js | 10 +- docs/search/all_17.js | 3 +- docs/search/all_18.js | 6 +- docs/search/all_2.js | 32 +- docs/search/all_3.js | 55 +- docs/search/all_4.js | 61 +- docs/search/all_5.js | 64 +- docs/search/all_6.js | 77 +- docs/search/all_7.js | 70 +- docs/search/all_8.js | 32 +- docs/search/all_9.js | 8 +- docs/search/all_a.js | 21 +- docs/search/all_b.js | 51 +- docs/search/all_c.js | 30 +- docs/search/all_d.js | 20 +- docs/search/all_e.js | 35 +- docs/search/all_f.js | 22 +- 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 | 12 +- docs/search/classes_5.js | 4 +- docs/search/classes_6.js | 4 +- docs/search/classes_7.js | 4 +- docs/search/classes_8.js | 12 +- docs/search/classes_9.js | 7 +- docs/search/classes_a.js | 2 +- docs/search/classes_b.js | 9 +- docs/search/classes_c.js | 4 +- docs/search/classes_d.js | 8 +- docs/search/classes_e.js | 5 +- 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 | 6 +- docs/search/files_1.js | 4 +- docs/search/files_2.js | 5 +- docs/search/files_3.js | 3 +- docs/search/files_4.js | 4 +- docs/search/functions_0.js | 7 +- docs/search/functions_1.js | 8 +- docs/search/functions_10.js | 30 +- docs/search/functions_11.js | 6 +- docs/search/functions_2.js | 20 +- docs/search/functions_3.js | 29 +- docs/search/functions_4.js | 18 +- docs/search/functions_5.js | 18 +- docs/search/functions_6.js | 34 +- docs/search/functions_7.js | 49 +- docs/search/functions_8.js | 7 +- docs/search/functions_9.js | 3 +- docs/search/functions_a.js | 12 +- docs/search/functions_b.js | 7 +- docs/search/functions_c.js | 8 +- docs/search/functions_d.js | 16 +- docs/search/functions_e.js | 25 +- docs/search/functions_f.js | 12 +- docs/search/related_0.js | 2 +- docs/search/searchdata.js | 24 +- docs/search/typedefs_0.js | 2 +- docs/search/typedefs_1.js | 8 +- docs/search/typedefs_2.js | 6 +- docs/search/typedefs_3.js | 2 +- docs/search/typedefs_4.js | 2 +- docs/search/typedefs_5.js | 2 +- docs/search/typedefs_6.js | 4 +- docs/search/typedefs_7.js | 2 +- docs/search/typedefs_8.js | 4 +- docs/search/typedefs_9.js | 6 +- docs/search/typedefs_a.js | 4 +- docs/search/typedefs_b.js | 3 +- 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 | 5 +- docs/search/variables_13.js | 5 +- docs/search/variables_14.js | 3 +- docs/search/variables_15.js | 5 +- docs/search/variables_16.js | 3 +- docs/search/variables_2.js | 11 +- docs/search/variables_3.js | 19 +- docs/search/variables_4.js | 33 +- docs/search/variables_5.js | 35 +- docs/search/variables_6.js | 6 +- docs/search/variables_7.js | 26 +- docs/search/variables_8.js | 2 +- docs/search/variables_9.js | 4 +- docs/search/variables_a.js | 30 +- docs/search/variables_b.js | 19 +- docs/search/variables_c.js | 14 +- docs/search/variables_d.js | 12 +- docs/search/variables_e.js | 12 +- docs/search/variables_f.js | 2 +- ...ivity_2functors_2logistic_8hpp_source.html | 70 +- docs/selectivity_8hpp_source.html | 31 +- docs/selectivity__base_8hpp_source.html | 89 +- docs/sr__beverton__holt_8hpp_source.html | 95 +- ...s__data__object_1_1DataObject-members.html | 55 +- ...tructfims__data__object_1_1DataObject.html | 13 +- ...__model__object_1_1FIMSObject-members.html | 13 +- ...ructfims__model__object_1_1FIMSObject.html | 72 +- ...tructfims__model__object_1_1FIMSObject.png | Bin 6033 -> 5398 bytes ..._1_1DoubleLogisticSelectivity-members.html | 14 +- ...s__popdy_1_1DoubleLogisticSelectivity.html | 100 +- ...ructfims__popdy_1_1EWAAgrowth-members.html | 22 +- docs/structfims__popdy_1_1EWAAgrowth.html | 29 +- docs/structfims__popdy_1_1Fleet-members.html | 50 +- docs/structfims__popdy_1_1Fleet.html | 350 +---- ...ructfims__popdy_1_1GrowthBase-members.html | 21 +- docs/structfims__popdy_1_1GrowthBase.html | 3 - ...ms__popdy_1_1LogisticMaturity-members.html | 8 +- ...structfims__popdy_1_1LogisticMaturity.html | 80 +- ..._popdy_1_1LogisticSelectivity-members.html | 8 +- ...uctfims__popdy_1_1LogisticSelectivity.html | 82 +- ...ctfims__popdy_1_1MaturityBase-members.html | 4 +- docs/structfims__popdy_1_1MaturityBase.html | 57 +- ...ructfims__popdy_1_1Population-members.html | 81 +- docs/structfims__popdy_1_1Population.html | 3 - ...ims__popdy_1_1RecruitmentBase-members.html | 25 +- .../structfims__popdy_1_1RecruitmentBase.html | 65 +- ...fims__popdy_1_1SRBevertonHolt-members.html | 31 +- docs/structfims__popdy_1_1SRBevertonHolt.html | 22 +- ...ims__popdy_1_1SelectivityBase-members.html | 4 +- .../structfims__popdy_1_1SelectivityBase.html | 57 +- docs/subpopulation_8hpp_source.html | 55 +- 276 files changed, 7701 insertions(+), 11884 deletions(-) diff --git a/docs/annotated.html b/docs/annotated.html index a5752de..cc29382 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -75,18 +75,12 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
- - - - - - - - - - - - + + + + + + @@ -110,9 +104,9 @@ - - - + + + @@ -120,13 +114,13 @@ - - - - + + + + - - + + diff --git a/docs/classAgeCompDataInterface-members.html b/docs/classAgeCompDataInterface-members.html index 4b3f825..7bc4e74 100644 --- a/docs/classAgeCompDataInterface-members.html +++ b/docs/classAgeCompDataInterface-members.html @@ -81,17 +81,14 @@ - - - - - - + + +
 Nfims
 CLogEntry
 CFIMSLog
 CVector
 CJsonValue
 CJsonParser
 Nfims_data_object
 CDataObject
 Nfims_distributions
 CDensityComponentBaseBase class for all module_name functors
 CLogNormalLPDF
 CMultinomialLPMF
 CNormalLPDF
 Cfims_log
 CVector
 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
 CBevertonHoltRecruitmentInterfaceRcpp interface for Beverton-Holt as an S4 object. To instantiate from R: beverton_holt <- new(beverton_holt)
 CDataInterfaceBaseRcpp interface for Data as an S4 object. To instantiate from R: fleet <- new(Data)
 CDistributionsInterfaceBaseDistributions Rcpp Interface
 CDlnormDistributionsInterfaceRcpp interface for Dlnorm as an S4 object. To instantiate from R: dlnorm_ <- new(DlnormDistribution)
 CDmultinomDistributionsInterfaceRcpp interface for Dmultinom as an S4 object. To instantiate from R: dmultinom_ <- new(DmultinomDistribution)
 CDnormDistributionsInterfaceRcpp interface for Dnorm as an S4 object. To instantiate from R: dnorm_ <- new(DnormDistribution)
 CDlnormDistributionsInterfaceRcpp interface for Dlnorm as an S4 object. To instantiate from R: dlnorm_ <- new(TMBDlnormDistribution)
 CDmultinomDistributionsInterfaceRcpp interface for Dmultinom as an S4 object. To instantiate from R: dmultinom_ <- new(TMBDmultinomDistribution)
 CDnormDistributionsInterfaceRcpp interface for Dnorm as an S4 object. To instantiate from R: dnorm_ <- new(TMBDnormDistribution)
 CDoubleLogisticSelectivityInterfaceRcpp interface for logistic selectivity as an S4 object. To instantiate from R: logistic_selectivity <- new(logistic_selectivity)
 CEWAAGrowthInterfaceRcpp interface for EWAAgrowth as an S4 object. To instantiate from R: ewaa <- new(EWAAgrowth)
 CFIMSRcppInterfaceBaseBase class for all interface objects
 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(Index)
 CLengthCompDataInterfaceRcpp interface for length comp data as an S4 object. To instantiate from R: lcomp <- new(LengthComp)
 CLogisticMaturityInterfaceRcpp interface for logistic maturity as an S4 object. To instantiate from R: logistic_maturity <- new(logistic_maturity)
 CLogisticSelectivityInterfaceRcpp interface for logistic selectivity as an S4 object. To instantiate from R: logistic_selectivity <- new(logistic_selectivity)
 CLPDFInterfaceBaseLPDFInterfaceBase class should be inherited to define different Rcpp interfaces for each possible log probability density function
 CJsonParser
 CJsonValue
 CLogisticMaturityInterfaceRcpp interface for logistic maturity as an S4 object. To instantiate from R: logistic_maturity <- new(logistic_maturity)
 CLogisticSelectivityInterfaceRcpp interface for logistic selectivity as an S4 object. To instantiate from R: logistic_selectivity <- new(logistic_selectivity)
 CMaturityInterfaceBaseMaturityInterfaceBase class should be inherited to define different Rcpp interfaces for each possible maturity function
 CParameterRcppInterface class that defines the interface between R and C++ for parameter types
 CParameterVectorRcpp representation of a Parameter vector interface between R and cpp
 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(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
amaxAgeCompDataInterface
DataInterfaceBase()DataInterfaceBaseinline
fims_interface_objectsFIMSRcppInterfaceBasestatic
finalize()FIMSRcppInterfaceBaseinlinevirtual
finalizedFIMSRcppInterfaceBase
get_id()AgeCompDataInterfaceinlinevirtual
idDataInterfaceBase
id_gDataInterfaceBasestatic
live_objectsDataInterfaceBasestatic
observed_dataDataInterfaceBase
to_json()AgeCompDataInterfaceinlinevirtual
ymaxAgeCompDataInterface
~AgeCompDataInterface()AgeCompDataInterfaceinlinevirtual
~DataInterfaceBase()DataInterfaceBaseinlinevirtual
ymaxAgeCompDataInterface
~AgeCompDataInterface()AgeCompDataInterfaceinlinevirtual
~DataInterfaceBase()DataInterfaceBaseinlinevirtual