LogDevsRecruitmentInterface Class Reference

Rcpp interface for Log–Devs to instantiate from R: log_devs <- methods::new(log_devs). More...

#include <rcpp_recruitment.hpp>

Inheritance diagram for LogDevsRecruitmentInterface:

Public Member Functions
	LogDevsRecruitmentInterface ()
	The constructor.
virtual	~LogDevsRecruitmentInterface ()
	The destructor.
virtual uint32_t	get_id ()
	Gets the ID of the interface base object.
virtual double	evaluate_mean (double spawners, double phi_0)
	Evaluates expected recruitment from the stock–recruitment relationship before recruitment-process deviations are applied.
virtual double	evaluate_process (size_t pos)
	Evaluate recruitment process using the Log–Devs approach.
Public Member Functions inherited from RecruitmentInterfaceBase
	RecruitmentInterfaceBase ()
	The constructor.
	RecruitmentInterfaceBase (const RecruitmentInterfaceBase &other)
	Construct a new Recruitment Interface Base object.
virtual	~RecruitmentInterfaceBase ()
	The destructor.
Public Member Functions inherited from FIMSRcppInterfaceBase
virtual bool	add_to_fims_tmb ()
	A virtual method to inherit to add objects to the TMB model.
virtual void	finalize ()
	Extracts derived quantities back to the Rcpp interface object from the Information object.
virtual std::string	to_json ()
	Convert the data to json representation for the output.
std::string	value_to_string (double value)
	Report the variable value as a string.
std::string	make_dimensions (uint32_t start, uint32_t end, uint32_t rep=1)
	Make a string of dimensions for the model.

Additional Inherited Members
Public Attributes inherited from RecruitmentInterfaceBase
uint32_t	id
	The local id of the RecruitmentInterfaceBase object.
SharedInt	process_id = -999
	The process id of the RecruitmentInterfaceBase object.
Public Attributes inherited from FIMSRcppInterfaceBase
bool	finalized = false
	Is the object already finalized? The default is false.
Static Public Attributes inherited from RecruitmentInterfaceBase
static uint32_t	id_g = 1
	The static id of the RecruitmentInterfaceBase object.
static std::map< uint32_t, std::shared_ptr< RecruitmentInterfaceBase > >	live_objects
	The map associating the IDs of RecruitmentInterfaceBase to the objects. This is a live object, which is an object that has been created and lives in memory.
Static Public Attributes inherited from FIMSRcppInterfaceBase
static std::vector< std::shared_ptr< FIMSRcppInterfaceBase > >	fims_interface_objects
	FIMS interface object vectors.

Detailed Description

Rcpp interface for Log–Devs to instantiate from R: log_devs <- methods::new(log_devs).

Member Function Documentation

evaluate_mean()

virtual double LogDevsRecruitmentInterface::evaluate_mean ( double  spawners, double  phi_0  )

inlinevirtual

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.

Returns

Expected recruitment before recruitment-process deviations or random effects are applied.

Implements RecruitmentInterfaceBase.

evaluate_process()

virtual double LogDevsRecruitmentInterface::evaluate_process ( size_t  pos )

inlinevirtual

Evaluate recruitment process using the Log–Devs approach.

Parameters

pos	Position index, e.g., which year.

Implements RecruitmentInterfaceBase.

get_id()

virtual uint32_t LogDevsRecruitmentInterface::get_id ( )

inlinevirtual

Gets the ID of the interface base object.

Returns

The ID.

Implements RecruitmentInterfaceBase.

---

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

• inst/include/interface/rcpp/rcpp_objects/rcpp_recruitment.hpp