LogisticSelectivityInterface Class Reference

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

#include <rcpp_selectivity.hpp>

Inheritance diagram for LogisticSelectivityInterface:

Public Member Functions
	LogisticSelectivityInterface ()
	The constructor.
	LogisticSelectivityInterface (const LogisticSelectivityInterface &other)
	Construct a new Logistic Selectivity Interface object.
virtual	~LogisticSelectivityInterface ()
	The destructor.
virtual uint32_t	get_id ()
	Gets the ID of the interface base object.
virtual double	evaluate (double x)
	Evaluate selectivity using the logistic function.
virtual void	finalize ()
	Extracts derived quantities back to the Rcpp interface object from the Information object.
virtual void	set_uncertainty (std::map< std::string, std::vector< double > > &se_values)
	Set uncertainty values for selectivity parameters.
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.
void	get_se_values (std::string name, std::map< std::string, std::vector< double > > &se_values, fims::Vector< double > &values)
	Method to extract standard error values from the se_values working map.
std::string	value_to_string (double value)
	Report the parameter 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
ParameterVector	inflection_point
	The index value at which the response reaches 0.5.
ParameterVector	slope
	The width of the curve at the inflection point.
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 to instantiate the object from R: logistic_selectivity <- methods::new(logistic_selectivity).

Constructor & Destructor Documentation

LogisticSelectivityInterface()

LogisticSelectivityInterface::LogisticSelectivityInterface ( const LogisticSelectivityInterface &  other )

inline

Construct a new Logistic Selectivity Interface object.

Parameters

other

Member Function Documentation

evaluate()

virtual double LogisticSelectivityInterface::evaluate ( double  x )

inlinevirtual

Evaluate selectivity using the logistic function.

Parameters

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

Implements SelectivityInterfaceBase.

finalize()

virtual void LogisticSelectivityInterface::finalize ( )

inlinevirtual

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

Reimplemented from FIMSRcppInterfaceBase.

get_id()

virtual uint32_t LogisticSelectivityInterface::get_id ( )

inlinevirtual

Gets the ID of the interface base object.

Returns

The ID.

Implements SelectivityInterfaceBase.

set_uncertainty()

virtual void LogisticSelectivityInterface::set_uncertainty ( std::map< std::string, std::vector< double > > &  se_values )

inlinevirtual

Set uncertainty values for selectivity parameters.

Sets the standard error values for the inflection point and slope parameters using the provided map.

Parameters

se_values

A map from parameter names to vectors of standard error values.

Reimplemented from FIMSRcppInterfaceBase.

to_json()

virtual std::string LogisticSelectivityInterface::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 logistic selectivity. 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