fims_popdy::GrowthDerivedObservationBase< Type > Class Template Reference

Generic capability interface for growth models that can feed the growth-derived age-to-length conversion / bin-based WAA path in catch-at-age. More...

#include <growth_model_adapter.hpp>

Inheritance diagram for fims_popdy::GrowthDerivedObservationBase< Type >:

Public Member Functions
virtual void	SetAgeOffset (double min_age)=0
	Set the minimum modeled age used to translate cached age indices.
virtual void	Initialize (std::size_t n_years, std::size_t n_ages, std::size_t n_sexes=1)=0
	Initialize any cached growth products.
virtual bool	SupportsAgeToLengthConversionDerived () const =0
	Report whether this growth object can support the dynamic age-to-length conversion path.
virtual void	PrepareGrowthProducts ()=0
	Prepare growth products for the current model state.
virtual const GrowthProducts< Type > *	TryGetPreparedGrowthProducts () const =0
	Return prepared growth products without triggering preparation.
virtual Type	EvaluateWeightAtLength (const Type &length) const =0
	Evaluate weight at a supplied length.
Public Member Functions inherited from fims_popdy::GrowthBase< Type >
	GrowthBase ()
	Constructor.
virtual const Type	evaluate (int year, const double &a)=0
	Calculates the growth 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.
Public Member Functions inherited from fims_model_object::FIMSMemoryTracker
void	register_self (const uint32_t id)
	Registers a FIMSObject instance with the memory tracker.

Additional Inherited Members
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
Static Public Attributes inherited from fims_popdy::GrowthBase< Type >
static uint32_t	id_g = 0
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>
class fims_popdy::GrowthDerivedObservationBase< Type >

Generic capability interface for growth models that can feed the growth-derived age-to-length conversion / bin-based WAA path in catch-at-age.

Member Function Documentation

EvaluateWeightAtLength()

template<typename Type >

virtual Type fims_popdy::GrowthDerivedObservationBase< Type >::EvaluateWeightAtLength ( const Type &  length ) const

pure virtual

Evaluate weight at a supplied length.

Parameters

length

Length on the natural scale.

Returns

Weight on the natural scale.

Implemented in fims_popdy::VonBertalanffySchnuteGrowthModelAdapter< Type >.

Initialize()

template<typename Type >

virtual void fims_popdy::GrowthDerivedObservationBase< Type >::Initialize ( std::size_t  n_years, std::size_t  n_ages, std::size_t  n_sexes = 1  )

pure virtual

Initialize any cached growth products.

Parameters

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

Implemented in fims_popdy::VonBertalanffySchnuteGrowthModelAdapter< Type >.

PrepareGrowthProducts()

template<typename Type >

virtual void fims_popdy::GrowthDerivedObservationBase< Type >::PrepareGrowthProducts ( )

pure virtual

Prepare growth products for the current model state.

Implemented in fims_popdy::VonBertalanffySchnuteGrowthModelAdapter< Type >.

SetAgeOffset()

template<typename Type >

virtual void fims_popdy::GrowthDerivedObservationBase< Type >::SetAgeOffset ( double  min_age )

pure virtual

Set the minimum modeled age used to translate cached age indices.

Parameters

min_age

Minimum age on the natural scale.

Implemented in fims_popdy::VonBertalanffySchnuteGrowthModelAdapter< Type >.

SupportsAgeToLengthConversionDerived()

template<typename Type >

virtual bool fims_popdy::GrowthDerivedObservationBase< Type >::SupportsAgeToLengthConversionDerived ( ) const

pure virtual

Report whether this growth object can support the dynamic age-to-length conversion path.

Returns

True when growth-derived age-to-length conversion calculations are available.

Implemented in fims_popdy::VonBertalanffySchnuteGrowthModelAdapter< Type >.

TryGetPreparedGrowthProducts()

template<typename Type >

virtual const GrowthProducts< Type > * fims_popdy::GrowthDerivedObservationBase< Type >::TryGetPreparedGrowthProducts ( ) const

pure virtual

Return prepared growth products without triggering preparation.

Returns

Pointer to prepared growth products, or nullptr if unavailable.

Implemented in fims_popdy::VonBertalanffySchnuteGrowthModelAdapter< Type >.

---

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

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