fims_distributions::DensityComponentBase< Type > Struct Template Reference

Base class for all module_name functors. More...

#include <density_components_base.hpp>

Inheritance diagram for fims_distributions::DensityComponentBase< Type >:

Public Member Functions
	DensityComponentBase ()
	Constructor.
virtual const Type	evaluate ()=0
	Generic probability density function. Calculates the pdf at the independent variable value.
Public Member Functions inherited from fims_model_object::FIMSObject< Type >
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.
virtual void	create_report_vectors (std::map< std::string, fims::Vector< fims::Vector< Type > > > &report_vectors)
	Create a map of report vectors for the object. used to populate the report_vectors map in FisheryModelBase.
virtual void	get_report_vector_count (std::map< std::string, size_t > &report_vector_count)
	Get the report vector count object. used to get the length of each report vector for populating the UncertaintyReportInfo struct in FisheryModelBase.
Public Member Functions inherited from fims_distributions::DistributionElementObject< Type >
Type &	get_observed (size_t i)
Type &	get_observed (size_t i, size_t j)
Type &	get_expected (size_t i)
size_t	get_n_x ()
size_t	get_n_expected ()

Public Attributes
int	observed_data_id_m = -999
fims::Vector< Type >	lpdf_vec
fims::Vector< Type >	report_lpdf_vec
bool	osa_flag = false
bool	simulate_flag
std::vector< uint32_t >	key
Public Attributes inherited from fims_model_object::FIMSObject< Type >
uint32_t	id
std::vector< Type * >	parameters
std::vector< Type * >	random_effects_parameters
std::vector< Type * >	fixed_effects_parameters
Public Attributes inherited from fims_distributions::DistributionElementObject< Type >
std::string	input_type
std::shared_ptr< fims_data_object::DataObject< Type > >	observed_values
fims::Vector< Type >	expected_values
fims::Vector< Type > *	re = NULL
fims::Vector< Type > *	re_expected_values
fims::Vector< Type > *	data_expected_values = NULL
std::vector< fims::Vector< Type > * >	priors
fims::Vector< Type >	x
fims::Vector< Type >	expected_mean
std::string	use_mean = fims::to_string("no")

Static Public Attributes
static uint32_t	id_g = 0
	Default id of the singleton distribution class.

Detailed Description

template<typename Type>
struct fims_distributions::DensityComponentBase< Type >

Base class for all module_name functors.

Template Parameters

Type	The type of the module_name functor.

Member Function Documentation

evaluate()

template<typename Type >

virtual const Type fims_distributions::DensityComponentBase< Type >::evaluate ( )

pure virtual

Generic probability density function. Calculates the pdf at the independent variable value.

Implemented in fims_distributions::LogNormalLPDF< Type >, fims_distributions::MultinomialLPMF< Type >, and fims_distributions::NormalLPDF< Type >.

Member Data Documentation

id_g

template<typename Type >

uint32_t fims_distributions::DensityComponentBase< Type >::id_g = 0

static

Default id of the singleton distribution class.

global unique identifier for distribution modules

key

template<typename Type >

std::vector<uint32_t> fims_distributions::DensityComponentBase< Type >::key

unique id for variable map that points to a fims::Vector

lpdf_vec

template<typename Type >

fims::Vector<Type> fims_distributions::DensityComponentBase< Type >::lpdf_vec

vector to record observation level negative log-likelihood values

observed_data_id_m

template<typename Type >

int fims_distributions::DensityComponentBase< Type >::observed_data_id_m = -999

id of observed data component

osa_flag

template<typename Type >

bool fims_distributions::DensityComponentBase< Type >::osa_flag = false

Boolean; if true, osa residuals are calculated

report_lpdf_vec

template<typename Type >

fims::Vector<Type> fims_distributions::DensityComponentBase< Type >::report_lpdf_vec

vector to record observation level negative log-likelihood values

simulate_flag

template<typename Type >

bool fims_distributions::DensityComponentBase< Type >::simulate_flag

Initial value:

=
      false

Boolean; if true, data are simulated from the distribution

---

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

• inst/include/distributions/functors/density_components_base.hpp