fims_popdy::GrowthModel< Type > Class Template Reference

Concrete growth model using VonBertalanffySchnute growth (Phase 1). More...

#include <growth_model.hpp>

Inheritance diagram for fims_popdy::GrowthModel< Type >:

Public Member Functions
	GrowthModel (std::size_t n_years, std::size_t n_ages, std::size_t n_sexes=1)
	Construct a growth model with fixed dimensions.
void	SetVonBertalanffySchnuteParameters (Type mean_length_young, Type mean_length_old, Type growth_coefficient, Type reference_age_for_length_young, Type reference_age_for_length_old)
	Set fixed VonBertalanffySchnute parameters (explicit reference ages).
void	SetLengthWeightParameters (Type length_weight_a, Type length_weight_b)
	fixed length-weight params (phase 1)
void	SetLengthSdParams (Type length_at_age_sd_at_reference_age_young, Type length_at_age_sd_at_reference_age_old)
void	SetGrowthParameterCovariance (Type mean_length_young_variance, Type mean_length_young_mean_length_old_covariance, Type mean_length_young_growth_coefficient_covariance, Type mean_length_old_variance, Type mean_length_old_growth_coefficient_covariance, Type growth_coefficient_variance)
void	ClearGrowthParameterCovariance ()
void	Prepare () override
	Compute and cache growth products.
const GrowthProducts< Type > &	GetProducts () const override
	Read-only access to cached growth products.
void	SetAgeOffset (Type offset)
	Set an age offset if population ages do not start at zero.

Detailed Description

template<typename Type>
class fims_popdy::GrowthModel< Type >

Concrete growth model using VonBertalanffySchnute growth (Phase 1).

Assumptions:

• single sex (n_sexes = 1)
• no time variation (n_years = 1)
• fixed mean-growth parameters
• optional covariance-based delta-method variability

Constructor & Destructor Documentation

GrowthModel()

template<typename Type >

fims_popdy::GrowthModel< Type >::GrowthModel ( std::size_t  n_years, std::size_t  n_ages, std::size_t  n_sexes = 1  )

inline

Construct a growth model with fixed dimensions.

Parameters

n_years	Number of years.
n_ages	Number of ages.
n_sexes	Number of sexes.

Member Function Documentation

ClearGrowthParameterCovariance()

template<typename Type >

void fims_popdy::GrowthModel< Type >::ClearGrowthParameterCovariance ( )

inline

Disable the delta-method growth variability path and return to the reference-point interpolation path.

GetProducts()

template<typename Type >

const GrowthProducts< Type > & fims_popdy::GrowthModel< Type >::GetProducts ( ) const

inlineoverridevirtual

Read-only access to cached growth products.

Implements fims_popdy::GrowthModelBase< Type >.

Prepare()

template<typename Type >

void fims_popdy::GrowthModel< Type >::Prepare ( )

inlineoverridevirtual

Compute and cache growth products.

Implements fims_popdy::GrowthModelBase< Type >.

SetGrowthParameterCovariance()

template<typename Type >

void fims_popdy::GrowthModel< Type >::SetGrowthParameterCovariance ( Type  mean_length_young_variance, Type  mean_length_young_mean_length_old_covariance, Type  mean_length_young_growth_coefficient_covariance, Type  mean_length_old_variance, Type  mean_length_old_growth_coefficient_covariance, Type  growth_coefficient_variance  )

inline

Set the covariance values used by the delta-method growth variability path.

The supplied covariance must match the current log-scale FIMS VonBertalanffySchnute estimation parameterization in this exact order:

1. log(mean_length_young)
2. log(mean_length_old)
3. log(growth_coefficient)

SetLengthSdParams()

template<typename Type >

void fims_popdy::GrowthModel< Type >::SetLengthSdParams ( Type  length_at_age_sd_at_reference_age_young, Type  length_at_age_sd_at_reference_age_old  )

inline

Set the reference-point SD values used by the interpolation variability path.

---

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

• inst/include/population_dynamics/growth/growth_model.hpp