fims_distributions::DistributionElementObject< Type > Struct Template Reference

#include <density_components_base.hpp>

Inheritance diagram for fims_distributions::DistributionElementObject< Type >:

Public Member Functions
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
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")

Detailed Description

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

Container to hold density components including pointers to density inputs.

Member Function Documentation

get_expected()

template<typename Type >

Type & fims_distributions::DistributionElementObject< Type >::get_expected ( size_t  i )

inline

Retrieve expected element given data, random effect, or prior.

Parameters

i	index referencing vector or pointer

Returns

the reference to the value of the vector or pointer at position i

get_n_expected()

template<typename Type >

size_t fims_distributions::DistributionElementObject< Type >::get_n_expected ( )

inline

Retrieve expected value element size given data, random effect, or prior.

Returns

The size of the element.

get_n_x()

template<typename Type >

size_t fims_distributions::DistributionElementObject< Type >::get_n_x ( )

inline

Retrieve expected element size given data, random effect, or prior.

Returns

The size of the element.

get_observed() [1/2]

template<typename Type >

Type & fims_distributions::DistributionElementObject< Type >::get_observed ( size_t  i )

inline

Retrieve element from observed data set, random effect, or prior.

Parameters

i	index referencing vector or pointer

Returns

the reference to the value of the vector or pointer at position i

get_observed() [2/2]

template<typename Type >

Type & fims_distributions::DistributionElementObject< Type >::get_observed ( size_t  i, size_t  j  )

inline

Retrieve element from observed data set, random effect, or prior.

Parameters

i	index referencing row
j	index referencing column

Returns

the reference to the row and column at position i, j

Member Data Documentation

data_expected_values

template<typename Type >

fims::Vector<Type>* fims_distributions::DistributionElementObject< Type >::data_expected_values = NULL

expected value of data

expected_mean

template<typename Type >

fims::Vector<Type> fims_distributions::DistributionElementObject< Type >::expected_mean

the expected mean of the distribution, overrides expected values

expected_values

template<typename Type >

fims::Vector<Type> fims_distributions::DistributionElementObject< Type >::expected_values

expected value of distribution function

input_type

template<typename Type >

std::string fims_distributions::DistributionElementObject< Type >::input_type

string classifies the type of the negative log-likelihood; options are: "priors", "random_effects", and "data"

observed_values

template<typename Type >

std::shared_ptr<fims_data_object::DataObject<Type> > fims_distributions::DistributionElementObject< Type >::observed_values

observed data

priors

template<typename Type >

std::vector<fims::Vector<Type>*> fims_distributions::DistributionElementObject< Type >::priors

vector of pointers where each points to a prior parameter

re

template<typename Type >

fims::Vector<Type>* fims_distributions::DistributionElementObject< Type >::re = NULL

pointer to random effects vector

re_expected_values

template<typename Type >

fims::Vector<Type>* fims_distributions::DistributionElementObject< Type >::re_expected_values

Initial value:

=
      NULL

expected value of random effects

use_mean

template<typename Type >

std::string fims_distributions::DistributionElementObject< Type >::use_mean = fims::to_string("no")

should expected_mean be used over expected values

x

template<typename Type >

fims::Vector<Type> fims_distributions::DistributionElementObject< Type >::x

input value of distribution function for priors or random effects

---

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

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