FIMS  v0.8.1
Loading...
Searching...
No Matches
fims_model_object::FIMSObject< Type > Struct Template Reference

FIMSObject struct that defines member types and returns the unique id. More...

#include <model_object.hpp>

Inheritance diagram for fims_model_object::FIMSObject< Type >:
fims_data_object::DataObject< Type > fims_distributions::DensityComponentBase< Type > fims_popdy::FisheryModelBase< Type > fims_popdy::Fleet< Type > fims_popdy::GrowthBase< Type > fims_popdy::MaturityBase< Type > fims_popdy::Population< Type > fims_popdy::RecruitmentBase< Type > fims_popdy::SelectivityBase< Type >

Public Member Functions

uint32_t GetId () const
 Getter that returns the unique id for parameters in the model.
 
bool CheckDimensions (size_t actual, size_t expected)
 Check the dimensions of an object.
 

Public Attributes

uint32_t id
 
std::vector< Type * > parameters
 
std::vector< Type * > random_effects_parameters
 
std::vector< Type * > fixed_effects_parameters
 

Detailed Description

template<typename Type>
struct fims_model_object::FIMSObject< Type >

FIMSObject struct that defines member types and returns the unique id.

Member Function Documentation

◆ CheckDimensions()

template<typename Type >
bool fims_model_object::FIMSObject< Type >::CheckDimensions ( size_t  actual,
size_t  expected 
)
inline

Check the dimensions of an object.

Parameters
actualThe actual dimensions.
expectedThe expected dimensions.
Returns
true
false

Member Data Documentation

◆ fixed_effects_parameters

template<typename Type >
std::vector<Type*> fims_model_object::FIMSObject< Type >::fixed_effects_parameters

list of fixed effects parameters

◆ id

unique identifier assigned for all fims objects

◆ parameters

template<typename Type >
std::vector<Type*> fims_model_object::FIMSObject< Type >::parameters

list of estimable parameters

◆ random_effects_parameters

template<typename Type >
std::vector<Type*> fims_model_object::FIMSObject< Type >::random_effects_parameters

list of all random effects parameters


The documentation for this struct was generated from the following file: