Base class for all recruitment functors. More...

#include <recruitment_base.hpp>

Inheritance diagram for fims_popdy::RecruitmentBase< Type >:

Public Member Functions
	RecruitmentBase ()
	Constructor.

void	Prepare ()
	Prepares the recruitment deviations vector.

virtual const Type	evaluate_mean (const Type &spawners, const Type &ssbzero)=0
	Calculates the expected recruitment for a given spawning input.

virtual const Type	evaluate_process (size_t pos)=0
	Handle error in recruitment.

void	PrepareConstrainedDeviations ()
	Prepare constrained recruitment deviations. Based on ADMB sum-to-zero constraint implementation. We still need to add an additional penalty to the PrepareConstrainedDeviations method. More discussion can be found here: https://groups.google.com/a/ADMB-project.org/g/users/c/63YJmYGEPuE.

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 Attributes
fims::Vector< Type >	log_recruit_devs

bool	constrain_deviations = false

fims::Vector< Type >	log_rzero

fims::Vector< Type >	log_r

fims::Vector< Type >	log_expected_recruitment

bool	estimate_log_recruit_devs = true

int	process_id = -999

std::shared_ptr< fims_popdy::RecruitmentBase< Type > >	process

std::shared_ptr< fims_popdy::RecruitmentBase< Type > >	recruitment

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
static uint32_t	id_g = 0

Detailed Description

template<class Type>
struct fims_popdy::RecruitmentBase< Type >

Base class for all recruitment functors.

Template Parameters

Type	The type of the recruitment functor.

Member Function Documentation

◆ evaluate_mean()

template<class Type >

virtual const Type fims_popdy::RecruitmentBase< Type >::evaluate_mean	(	const Type &	spawners,
		const Type &	ssbzero
	)

pure virtual

Calculates the expected recruitment for a given spawning input.

Recruitment is evaluated for the first age you have in your data. For example, if you have age-1 fish in your weight-at-age and age- composition data then recruitment will happen for age-1 fish, not age-0. There is no way to set the age at which this function is evaluated for, it is solely based on your input data.

Parameters