fims_popdy::SelectivityBase< Type > Struct Template Reference

Base class for all selectivity functors. More...

#include <selectivity_base.hpp>

Inheritance diagram for fims_popdy::SelectivityBase< Type >:

Public Member Functions
	SelectivityBase ()
	Constructor.
virtual const Type	evaluate (const Type &x)=0
	Calculates the selectivity.
virtual const Type	evaluate (const Type &x, size_t pos)=0
	Calculates the selectivity.
Public Member Functions inherited from fims_model_object::FIMSObject< Type >
uint32_t	GetId () const
	Getter that returns the unique id for parameters in the model.
bool	CheckDimensions (size_t actual, size_t expected)
	Check the dimensions of an object.
virtual void	create_report_vectors (std::map< std::string, fims::Vector< fims::Vector< Type > > > &report_vectors)
	Create a map of report vectors for the object. used to populate the report_vectors map in FisheryModelBase.
virtual void	get_report_vector_count (std::map< std::string, size_t > &report_vector_count)
	Get the report vector count object. used to get the length of each report vector for populating the UncertaintyReportInfo struct in FisheryModelBase.

Static Public Attributes
static uint32_t	id_g = 0

Additional Inherited Members
Public Attributes inherited from fims_model_object::FIMSObject< Type >
uint32_t	id
std::vector< Type * >	parameters
std::vector< Type * >	random_effects_parameters
std::vector< Type * >	fixed_effects_parameters

Detailed Description

template<typename Type>
struct fims_popdy::SelectivityBase< Type >

Base class for all selectivity functors.

Template Parameters

Type	The type of the selectivity functor.

Member Function Documentation

evaluate() [1/2]

template<typename Type >

virtual const Type fims_popdy::SelectivityBase< Type >::evaluate ( const Type &  x )

pure virtual

Calculates the selectivity.

Parameters

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

Implemented in fims_popdy::DoubleLogisticSelectivity< Type >, and fims_popdy::LogisticSelectivity< Type >.

evaluate() [2/2]

template<typename Type >

virtual const Type fims_popdy::SelectivityBase< Type >::evaluate ( const Type &  x, size_t  pos  )

pure virtual

Calculates the selectivity.

Parameters

x	The independent variable in the logistic function (e.g., age or size in selectivity).
pos	Position index, e.g., which year.

Implemented in fims_popdy::DoubleLogisticSelectivity< Type >, and fims_popdy::LogisticSelectivity< Type >.

Member Data Documentation

id_g

template<typename Type >

uint32_t fims_popdy::SelectivityBase< Type >::id_g = 0

static

The ID of the instance of the SelectivityBase class

---

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

• inst/include/population_dynamics/selectivity/functors/selectivity_base.hpp