fims_popdy::AgeToLengthConversionFixed< Type > Struct Template Reference

Fixed age-to-length conversion implementation using a fleet's stored age-to-length conversion matrix. More...

#include <fixed.hpp>

Inheritance diagram for fims_popdy::AgeToLengthConversionFixed< Type >:

Public Member Functions
	AgeToLengthConversionFixed (const std::shared_ptr< Fleet< Type > > &fleet)
	Constructor.
virtual	~AgeToLengthConversionFixed ()
	Destructor.
virtual bool	IsActive () const override
	Returns whether this fixed-matrix age-to-length conversion is active and usable.
virtual bool	PrepareForCurrentState () override
	Prepare the fixed-matrix age-to-length conversion for the current model state.
virtual bool	BuildAgeToLengthConversionRow (size_t year, size_t age, fims::Vector< Type > &out_row) const override
	Builds the fixed age-to-length conversion row for a given age.
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.

Public Attributes
std::weak_ptr< Fleet< Type > >	fleet
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

Additional Inherited Members
Static Public Attributes inherited from fims_popdy::AgeToLengthConversionBase< Type >
static uint32_t	id_g
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>
struct fims_popdy::AgeToLengthConversionFixed< Type >

Fixed age-to-length conversion implementation using a fleet's stored age-to-length conversion matrix.

Constructor & Destructor Documentation

AgeToLengthConversionFixed()

template<typename Type >

fims_popdy::AgeToLengthConversionFixed< Type >::AgeToLengthConversionFixed ( const std::shared_ptr< Fleet< Type > > &  fleet )

inline

Constructor.

Parameters

fleet

Shared pointer to the fleet providing the fixed age-to-length conversion matrix.

Member Function Documentation

BuildAgeToLengthConversionRow()

template<typename Type >

virtual bool fims_popdy::AgeToLengthConversionFixed< Type >::BuildAgeToLengthConversionRow ( size_t  year, size_t  age, fims::Vector< Type > &  out_row  ) const

inlineoverridevirtual

Builds the fixed age-to-length conversion row for a given age.

Parameters

year	Year index. Unused for the current fixed-matrix path.
age	Age index.
out_row	Output age-to-length probability row.

Returns

True if the age-to-length conversion row was built successfully.

Implements fims_popdy::AgeToLengthConversionBase< Type >.

IsActive()

template<typename Type >

virtual bool fims_popdy::AgeToLengthConversionFixed< Type >::IsActive ( ) const

inlineoverridevirtual

Returns whether this fixed-matrix age-to-length conversion is active and usable.

Returns

True if the fleet has a valid fixed age-to-length matrix.

Implements fims_popdy::AgeToLengthConversionBase< Type >.

PrepareForCurrentState()

template<typename Type >

virtual bool fims_popdy::AgeToLengthConversionFixed< Type >::PrepareForCurrentState ( )

inlineoverridevirtual

Prepare the fixed-matrix age-to-length conversion for the current model state.

Returns

True if the fixed matrix is active and usable.

Implements fims_popdy::AgeToLengthConversionBase< Type >.

Member Data Documentation

fleet

template<typename Type >

std::weak_ptr<Fleet<Type> > fims_popdy::AgeToLengthConversionFixed< Type >::fleet

non-owning link to the fleet

---

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

• inst/include/population_dynamics/age_to_length_conversion/functors/fixed.hpp