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 &phi_0)=0
	Evaluates expected recruitment from the stock–recruitment relationship before recruitment-process deviations are applied.

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 &	phi_0
	)

pure virtual

Evaluates expected recruitment from the stock–recruitment relationship before recruitment-process deviations are applied.

Recruitment is evaluated for the first age represented in the input data. For example, if the weight-at-age and age-composition data start at age 1, recruitment is evaluated for age-1 fish rather than age-0 fish. The recruitment age is not set directly by this function; it is determined by the age structure of the input data.

Recruitment functors that do not define a stock–recruitment mean return the default value of zero.

Parameters

spawners	Spawning output at the time step being evaluated, such as spawning biomass or another model-specific measure of reproductive output.
phi_0	Spawners per recruit at unfished equilibrium, used to scale the stock–recruitment relationship relative to unfished conditions.