Rcpp interface that serves as the parent class for Rcpp selectivity interfaces. This type should be inherited and not called from R directly. More...

Inheritance diagram for SelectivityInterfaceBase:

Public Member Functions
	SelectivityInterfaceBase ()
	The constructor.

	SelectivityInterfaceBase (const SelectivityInterfaceBase &other)
	Construct a new Selectivity Interface Base object.

virtual	~SelectivityInterfaceBase ()
	The destructor.

virtual uint32_t	get_id ()=0
	Get the ID for the child selectivity interface objects to inherit.

virtual double	evaluate (double x)=0
	A method for each child selectivity interface object to inherit so each selectivity option can have an evaluate() function.

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.

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.

virtual void	set_uncertainty (std::map< std::string, std::vector< double > > &se_values)
	Set uncertainty values for the interface object.

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
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.

Static Public Attributes
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 that serves as the parent class for Rcpp selectivity interfaces. This type should be inherited and not called from R directly.

Constructor & Destructor Documentation

SelectivityInterfaceBase::SelectivityInterfaceBase ( const SelectivityInterfaceBase & other )

inline

Construct a new Selectivity Interface Base object.

Parameters

other

virtual double SelectivityInterfaceBase::evaluate ( double x )

pure virtual

A method for each child selectivity interface object to inherit so each selectivity option can have an evaluate() function.

virtual uint32_t SelectivityInterfaceBase::get_id ( )

pure virtual

Get the ID for the child selectivity interface objects to inherit.

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