fims_popdy::SRBevertonHolt< Type > Struct Template Reference

BevertonHolt class that returns the Beverton–Holt stock–recruitment from fims_math. More...

#include <sr_beverton_holt.hpp>

Inheritance diagram for fims_popdy::SRBevertonHolt< Type >:

Public Member Functions
virtual const Type	evaluate_mean (const Type &spawners, const Type &phi_0)
	Beverton–Holt implementation of the stock–recruitment function.
virtual const Type	evaluate_process (size_t pos)
virtual void	create_report_vectors (std::map< std::string, fims::Vector< fims::Vector< Type > > > &report_vectors)
	Create a map of report vectors for the recruitment object.
virtual void	get_report_vector_count (std::map< std::string, size_t > &report_vector_count)
	Get the report vector count object. used to get the length of each report vector for populating the UncertaintyReportInfo struct in FisheryModelBase.
Public Member Functions inherited from fims_popdy::RecruitmentBase< Type >
	RecruitmentBase ()
	Constructor.
void	Prepare ()
	Prepares the recruitment deviations vector.
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 >	logit_steep
Public Attributes inherited from fims_popdy::RecruitmentBase< Type >
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

Additional Inherited Members
Static Public Attributes inherited from fims_popdy::RecruitmentBase< Type >
static uint32_t	id_g = 0

Detailed Description

template<typename Type>
struct fims_popdy::SRBevertonHolt< Type >

BevertonHolt class that returns the Beverton–Holt stock–recruitment from fims_math.

Parameters

logit_steep

Recruitment relative to unfished recruitment at 20 percent of unfished spawning biomass. Steepness is subject to a logit transformation to keep it between 0.2 and 1.0.

Member Function Documentation

create_report_vectors()

template<typename Type >

virtual void fims_popdy::SRBevertonHolt< Type >::create_report_vectors ( std::map< std::string, fims::Vector< fims::Vector< Type > > > &  report_vectors )

inlinevirtual

Create a map of report vectors for the recruitment object.

Reimplemented from fims_model_object::FIMSObject< Type >.

evaluate_mean()

template<typename Type >

virtual const Type fims_popdy::SRBevertonHolt< Type >::evaluate_mean ( const Type &  spawners, const Type &  phi_0  )

inlinevirtual

Beverton–Holt implementation of the stock–recruitment function.

The Beverton–Holt stock–recruitment implementation: \( \frac{0.8 R_{0} h S_{t-1}}{0.2 R_{0} \phi_{0} (1 - h) + S_{t-1} (h - 0.2)} \)

Parameters

spawners	A measure of spawning output.
phi_0	Number of spawners per recruit of an unfished population

Implements fims_popdy::RecruitmentBase< Type >.

evaluate_process()

template<typename Type >

virtual const Type fims_popdy::SRBevertonHolt< Type >::evaluate_process ( size_t  pos )

inlinevirtual

Empty return of base class function

Parameters

pos	position index

Implements fims_popdy::RecruitmentBase< Type >.

get_report_vector_count()

template<typename Type >

virtual void fims_popdy::SRBevertonHolt< Type >::get_report_vector_count ( std::map< std::string, size_t > &  report_vector_count )

inlinevirtual

Get the report vector count object. used to get the length of each report vector for populating the UncertaintyReportInfo struct in FisheryModelBase.

Reimplemented from fims_model_object::FIMSObject< Type >.

Member Data Documentation

logit_steep

template<typename Type >

fims::Vector<Type> fims_popdy::SRBevertonHolt< Type >::logit_steep

Transformed value of recruitment relative to unfished recruitment at 20 percent of unfished spawning biomass.

---

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

• inst/include/population_dynamics/recruitment/functors/sr_beverton_holt.hpp