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 >:

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 Member Functions inherited from fims_model_object::FIMSMemoryTracker
void	register_self (const uint32_t id)
	Registers a FIMSObject instance with the memory tracker.

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

Additional Inherited Members
Static Public Attributes inherited from fims_model_object::FIMSMemoryTracker
static int	total_active_objects = 0
	Total number of active FIMSObject instances currently in memory.

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

actual	The actual dimensions.
expected	The 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

template<typename Type >

uint32_t fims_model_object::FIMSObject< Type >::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:

• inst/include/common/model_object.hpp