FIMS  v0.11.0
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
 Nfims
 CLogEntryA data structure with defined fields for a single log record
 CFIMSLogSingleton logger for FIMS
 CVector
 CJsonValue
 CJsonParser
 Nfims_data_object
 CDataObject
 Nfims_distributions
 CDensityComponentBaseBase class for all module_name functors
 CLogNormalLPDFImplements the LogNormalLPDF distribution functor used by FIMS to evaluate observation-level and total log-likelihood contributions under a lognormal error model for data, priors, and random effects.
 CMultinomialLPMFImplements the MultinomialLPMF distribution functor used by FIMS to evaluate the observation-level and total log-likelihood contributions under a multinomial error model for data, priors, and random effects.
 CNormalLPDFImplements the NormalLPDF distribution functor used by FIMS to evaluate observation-level and total log-likelihood contributions under a normal error model for data, priors, and random effects.
 Nfims_info
 CInformationStores FIMS model information and creates model. Contains all objects and data pre-model construction
 Nfims_model_object
 CFIMSMemoryTrackerFIMS struct that tracks object memory for leak detection
 CFIMSObjectFIMSObject struct that defines member types and returns the unique id
 Nfims_popdyThe population dynamics of FIMS
 CCatchAtAgeCatchAtAge is a class containing a catch-at-age model, which is just one of many potential fishery models that can be used in FIMS. The CatchAtAge class inherits from the FisheryModelBase class and can be used to fit both age and length data even though it is called CatchAtAge
 CDimensionInfoStructure to hold dimension information for derived quantities
 CFisheryModelBaseFisheryModelBase is a base class for fishery models in FIMS
 CAgeToLengthConversionBaseBase interface for age-length key implementations
 CAgeToLengthConversionDerivedGrowth-derived age-to-length conversion implementation that reads prepared population age-to-size probabilities and maps them into fleet observation bins
 CAgeToLengthConversionFixedFixed age-to-length conversion implementation using a fleet's stored age-to-length conversion matrix
 CFleetBase class for all fleets
 CEWAAGrowthEWAAGrowth class that returns the EWAA function value
 CGrowthBaseBase class for all growth functors
 CVonBertalanffySchnuteGrowthVonBertalanffySchnute growth functor for length-at-age and weight-at-age
 CGrowthModelConcrete growth model using VonBertalanffySchnute growth (Phase 1)
 CGrowthDerivedObservationBaseGeneric capability interface for growth models that can feed the growth-derived age-to-length conversion / bin-based WAA path in catch-at-age
 CVonBertalanffySchnuteGrowthModelAdapterVon Bertalanffy–Schnute growth model adapter implementing the generic growth-derived observation capability for catch-at-age
 CGrowthModelBaseGrowth module boundary (product-oriented)
 CGrowthProductsGrowth "products" in a consistent (year, age, sex) space
 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 (e.g., sex, area)
 CSubpopulation
 CLogDevsLog Devs class that returns the log of the input added to the log of the recruitment deviations
 CLogRLog Devs class that returns the log of the input added to the log of the recruitment deviations
 CRecruitmentBaseBase class for all recruitment functors
 CSRBevertonHoltBevertonHolt class that returns the Beverton–Holt stock–recruitment from fims_math
 CAgeSpecificSelectivityAge-specific selectivity calculated using one parameter per age bin
 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
 CSizeBinMappingHelper for mapping population biological size bins to observed fleet bins
 CSizeGridBuilderHelper for constructing internally consistent population size grids
 CGrowthDerivedSizeProviderSize provider that converts growth outputs to population size products
 CSizeDistributionProviderBaseBase interface for objects that provide population-level size distributions
 CSizeGridPopulation-level biological size grid
 CSizeProductsCached population-level size outputs on a biological size grid
 CAgeCompDataInterfaceThe Rcpp interface for AgeComp to instantiate the object from R: acomp <- methods::new(AgeComp)
 CAgeSpecificSelectivityInterfaceRcpp interface for selectivity_at_age to instantiate the object from R: selectivity_at_age <- methods::new(selectivity_at_age)
 CBevertonHoltRecruitmentInterfaceRcpp interface for Beverton–Holt to instantiate from R: beverton_holt <- methods::new(beverton_holt)
 CCatchAtAgeInterfaceUsed to interface with the CatchAtAge model. It inherits from the FisheryModelInterfaceBase class
 CCatchDataInterfaceThe Rcpp interface for Catch to instantiate the object from R: fleet <- methods::new(Catch)
 CDataInterfaceBaseRcpp interface that serves as the parent class for Rcpp data interfaces. This type should be inherited and not called from R directly
 CDistributionsInterfaceBaseRcpp interface that serves as the parent class for Rcpp distribution interfaces. This type should be inherited and not called from R directly
 CDlnormDistributionsInterfaceThe Rcpp interface for Dlnorm to instantiate from R: dlnorm_ <- methods::new(DlnormDistribution)
 CDmultinomDistributionsInterfaceThe Rcpp interface for Dmultinom to instantiate from R: dmultinom_ <- methods::new(DmultinomDistribution)
 CDnormDistributionsInterfaceThe Rcpp interface for Dnorm to instantiate from R: dnorm_ <- methods::new(DnormDistribution)
 CDoubleLogisticSelectivityInterfaceRcpp interface for logistic selectivity as an S4 object. To instantiate from R: logistic_selectivity <- methods::new(logistic_selectivity)
 CEWAAGrowthInterfaceRcpp interface for EWAAGrowth to instantiate the object from R: ewaa <- methods::new(EWAAGrowth). Where, EWAA stands for empirical weight at age and growth is not actually estimated
 CFIMSRcppInterfaceBaseBase class for all interface objects
 CFisheryModelInterfaceBaseBase class for all fishery models in the FIMS Rcpp interface. It inherits from the FIMSRcppInterfaceBase
 CFleetInterfaceThe Rcpp interface for Fleet to instantiate from R: fleet <- methods::new(Fleet)
 CFleetInterfaceBaseRcpp interface that serves as the parent class for Rcpp fleet interfaces. This type should be inherited and not called from R directly
 CGrowthDerivedObservationInterfaceBaseRcpp interface base for growth models that can register a growth-derived observation capability with the runtime model
 CGrowthInterfaceBaseRcpp interface that serves as the parent class for Rcpp growth interfaces. This type should be inherited and not called from R directly
 CIndexDataInterfaceThe Rcpp interface for Index to instantiate the object from R: fleet <- methods::new(Index)
 CLengthCompDataInterfaceThe Rcpp interface for LengthComp to instantiate the object from R: lcomp <- methods::new(LengthComp)
 CLogDevsRecruitmentInterfaceRcpp interface for Log–Devs to instantiate from R: log_devs <- methods::new(log_devs)
 CLogisticMaturityInterfaceRcpp interface for logistic maturity to instantiate the object from R: logistic_maturity <- methods::new(logistic_maturity)
 CLogisticSelectivityInterfaceRcpp interface for logistic selectivity to instantiate the object from R: logistic_selectivity <- methods::new(logistic_selectivity)
 CLogRRecruitmentInterfaceRcpp interface for Log–R to instantiate from R: log_r <- methods::new(log_r)
 CMaturityInterfaceBaseRcpp interface that serves as the parent class for Rcpp maturity interfaces. This type should be inherited and not called from R directly
 CPopulationInterfaceRcpp interface for a new Population to instantiate from R: population <- methods::new(population)
 CPopulationInterfaceBaseRcpp interface that serves as the parent class for Rcpp population interfaces. This type should be inherited and not called from R directly
 CRealVectorAn Rcpp interface class that defines the RealVector class
 CRecruitmentInterfaceBaseRcpp interface that serves as the parent class for Rcpp recruitment interfaces. This type should be inherited and not called from R directly
 CSelectivityInterfaceBaseRcpp interface that serves as the parent class for Rcpp selectivity interfaces. This type should be inherited and not called from R directly
 CSharedBooleanA class that provides shared ownership of a boolean value
 CSharedIntA class that provides shared ownership of an integer value
 CSharedRealA class that provides shared ownership of an integer value
 CSharedStringA class that provides shared ownership of a string
 CVariableAn Rcpp interface that defines the Variable class
 CVariableVectorAn Rcpp interface class that defines the VariableVector class
 CVonBertalanffySchnuteGrowthInterfaceRcpp-facing VonBertalanffySchnute growth module. Inherits "derived observation" capability so this growth can support growth-derived outputs used by downstream age-to-length conversion/weight- at-age paths