FIMS  v0.8.0
Loading...
Searching...
No Matches
fims_distributions::LogNormalLPDF< Type > Struct Template Reference

#include <lognormal_lpdf.hpp>

Inheritance diagram for fims_distributions::LogNormalLPDF< Type >:
fims_distributions::DensityComponentBase< Type > fims_model_object::FIMSObject< Type > fims_distributions::DistributionElementObject< Type >

Public Member Functions

 LogNormalLPDF ()
 Constructor.
 
virtual ~LogNormalLPDF ()
 Destructor.
 
virtual const Type evaluate ()
 Evaluates the lognormal probability density function.
 
- Public Member Functions inherited from fims_distributions::DensityComponentBase< Type >
 DensityComponentBase ()
 Constructor.
 
- 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 >
Typeget_observed (size_t i)
 
Typeget_observed (size_t i, size_t j)
 
Typeget_expected (size_t i)
 
size_t get_n_x ()
 
size_t get_n_expected ()
 

Public Attributes

fims::Vector< Typelog_sd
 
Type lpdf = static_cast<Type>(0.0)
 
- Public Attributes inherited from fims_distributions::DensityComponentBase< Type >
int observed_data_id_m = -999
 
fims::Vector< Typelpdf_vec
 
fims::Vector< Typereport_lpdf_vec
 
bool osa_flag = false
 
bool simulate_flag
 
std::vector< uint32_tkey
 
- 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< Typeexpected_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< Typex
 
fims::Vector< Typeexpected_mean
 
std::string use_mean = fims::to_string("no")
 

Additional Inherited Members

- Static Public Attributes inherited from fims_distributions::DensityComponentBase< Type >
static uint32_t id_g = 0
 Default id of the singleton distribution class.
 

Detailed Description

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

LogNormal Log Probability Density Function

Member Function Documentation

◆ evaluate()

template<typename Type >
virtual const Type fims_distributions::LogNormalLPDF< Type >::evaluate ( )
inlinevirtual

Evaluates the lognormal probability density function.

Implements fims_distributions::DensityComponentBase< Type >.

Member Data Documentation

◆ log_sd

natural log of the standard deviation of the distribution on the log scale; can be a vector or scalar

◆ lpdf

total log probability density contribution of the distribution


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