AgeSpecificSelectivityInterface Class Reference

Rcpp interface for selectivity_at_age to instantiate the object from R: selectivity_at_age <- methods::new(selectivity_at_age). More...

#include <rcpp_selectivity.hpp>

Inheritance diagram for AgeSpecificSelectivityInterface:

Public Member Functions
	AgeSpecificSelectivityInterface ()
	The constructor.
	AgeSpecificSelectivityInterface (const AgeSpecificSelectivityInterface &other)
	Construct a new Selectivity-at-age Interface object.
virtual	~AgeSpecificSelectivityInterface ()
	The destructor.
virtual uint32_t	get_id ()
	Gets the ID of the interface base object.
virtual double	evaluate (double x)
	Evaluate selectivity using fims_math::inv_logit.
virtual void	finalize ()
	Extracts derived quantities back to the Rcpp interface object from the Information object.
virtual std::string	to_json ()
	Converts 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
SharedInt	n_ages = 1
	The number of age bins.
RealVector	ages
	Vector of ages.
SharedInt	min_age = 1
	Minimum observed age.
VariableVector	logit_sel_at_age
	Age-specific selectivity parameter values.
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 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 selectivity_at_age to instantiate the object from R: selectivity_at_age <- methods::new(selectivity_at_age).

Constructor & Destructor Documentation

AgeSpecificSelectivityInterface()

AgeSpecificSelectivityInterface::AgeSpecificSelectivityInterface ( const AgeSpecificSelectivityInterface & other )

inline

Construct a new Selectivity-at-age Interface object.

Parameters

other

Member Function Documentation

evaluate()

virtual double AgeSpecificSelectivityInterface::evaluate ( double x )

inlinevirtual

Evaluate selectivity using fims_math::inv_logit.

Parameters

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

Implements SelectivityInterfaceBase.

finalize()

virtual void AgeSpecificSelectivityInterface::finalize ( )

inlinevirtual

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

Reimplemented from FIMSRcppInterfaceBase.

get_id()

virtual uint32_t AgeSpecificSelectivityInterface::get_id ( )

inlinevirtual

Gets the ID of the interface base object.

Returns

The ID.

Implements SelectivityInterfaceBase.

to_json()

virtual std::string AgeSpecificSelectivityInterface::to_json ( )

inlinevirtual

Converts the data to json representation for the output.

Returns

A string is returned specifying that the module relates to the selectivity interface with selectivity-at-age. It also returns the ID and the parameters. This string is formatted for a json file.

Reimplemented from FIMSRcppInterfaceBase.

---

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

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