DoubleLogisticSelectivityInterface Class Reference

Rcpp interface for logistic selectivity as an S4 object. To instantiate from R: logistic_selectivity <- methods::new(logistic_selectivity) More...

#include <rcpp_selectivity.hpp>

Inheritance diagram for DoubleLogisticSelectivityInterface:

Public Member Functions
	DoubleLogisticSelectivityInterface (const DoubleLogisticSelectivityInterface &other)
	Construct a new Double Logistic Selectivity Interface object.
virtual uint32_t	get_id ()
	returns the id for the double logistic selectivity interface
virtual double	evaluate (double x)
	evaluate the double logistic selectivity function
virtual void	finalize ()
	finalize function. 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.
Public Member Functions inherited from SelectivityInterfaceBase
	SelectivityInterfaceBase ()
	The constructor.
	SelectivityInterfaceBase (const SelectivityInterfaceBase &other)
	Construct a new Selectivity Interface Base object.
virtual	~SelectivityInterfaceBase ()
	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.
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.

Public Attributes
VariableVector	inflection_point_asc
	The age at which the ascending limb is 0.5 for models that start at age zero and each age bin represents one year.
VariableVector	slope_asc
	How quickly selectivity rises on the ascending limb; larger values give a steeper, more knife-edge rise.
VariableVector	inflection_point_desc
	The age at which the descending limb is 0.5 for models that start at age zero and each age bin represents one year.
VariableVector	slope_desc
	How quickly selectivity falls on the descending limb; larger values give a steeper decline.
Public Attributes inherited from SelectivityInterfaceBase
uint32_t	id
	The local id of the SelectivityInterfaceBase object.
Public Attributes inherited from FIMSRcppInterfaceBase
bool	finalized = false
	Is the object already finalized? The default is false.

Additional Inherited Members
Static Public Attributes inherited from SelectivityInterfaceBase
static uint32_t	id_g = 1
	The static id of the SelectivityInterfaceBase.
static std::map< uint32_t, std::shared_ptr< SelectivityInterfaceBase > >	live_objects
	The map associating the IDs of SelectivityInterfaceBase 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 logistic selectivity as an S4 object. To instantiate from R: logistic_selectivity <- methods::new(logistic_selectivity)

Constructor & Destructor Documentation

DoubleLogisticSelectivityInterface()

DoubleLogisticSelectivityInterface::DoubleLogisticSelectivityInterface ( const DoubleLogisticSelectivityInterface &  other )

inline

Construct a new Double Logistic Selectivity Interface object.

Parameters

other

Member Function Documentation

evaluate()

virtual double DoubleLogisticSelectivityInterface::evaluate ( double  x )

inlinevirtual

evaluate the double logistic selectivity function

Parameters

x	The independent variable in the logistic function (e.g., age or size in selectivity).

Implements SelectivityInterfaceBase.

finalize()

virtual void DoubleLogisticSelectivityInterface::finalize ( )

inlinevirtual

finalize function. Extracts derived quantities back to the Rcpp interface object from the Information object.

Reimplemented from FIMSRcppInterfaceBase.

get_id()

virtual uint32_t DoubleLogisticSelectivityInterface::get_id ( )

inlinevirtual

returns the id for the double logistic selectivity interface

Implements SelectivityInterfaceBase.

to_json()

virtual std::string DoubleLogisticSelectivityInterface::to_json ( )

inlinevirtual

Convert the data to json representation for the output.

Reimplemented from FIMSRcppInterfaceBase.

Member Data Documentation

inflection_point_asc

VariableVector DoubleLogisticSelectivityInterface::inflection_point_asc

The age at which the ascending limb is 0.5 for models that start at age zero and each age bin represents one year.

Overall selectivity is below 0.5 at this point because it is the product of both limbs.

inflection_point_desc

VariableVector DoubleLogisticSelectivityInterface::inflection_point_desc

The age at which the descending limb is 0.5 for models that start at age zero and each age bin represents one year.

Overall selectivity is below 0.5 at this point because it is the product of both limbs.

slope_asc

VariableVector DoubleLogisticSelectivityInterface::slope_asc

How quickly selectivity rises on the ascending limb; larger values give a steeper, more knife-edge rise.

Scalar multiplier applied to the difference between x and inflection_point_asc on the ascending limb.

slope_desc

VariableVector DoubleLogisticSelectivityInterface::slope_desc

How quickly selectivity falls on the descending limb; larger values give a steeper decline.

Scalar multiplier applied to the difference between x and inflection_point_desc on the descending limb.

---

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

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