fims_popdy::LogisticSelectivity< Type > Struct Template Reference

LogisticSelectivity class that returns the logistic function value from fims_math. More...

#include <logistic.hpp>

Inheritance diagram for fims_popdy::LogisticSelectivity< Type >:

Public Member Functions
virtual const Type	evaluate (const Type &x)
	Method of the logistic selectivity class that implements the logistic function from FIMS math.
virtual const Type	evaluate (const Type &x, size_t pos)
	Method of the logistic selectivity class that implements the logistic function from FIMS math.
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.
Public Member Functions inherited from fims_popdy::SelectivityBase< Type >
	SelectivityBase ()
	Constructor.
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.

Public Attributes
fims::Vector< Type >	inflection_point
fims::Vector< Type >	slope
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

Additional Inherited Members
Static Public Attributes inherited from fims_popdy::SelectivityBase< Type >
static uint32_t	id_g = 0

Detailed Description

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

LogisticSelectivity class that returns the logistic function value from fims_math.

The logistic selectivity function can produce either an ascending or descending curve based on the sign of the slope parameter. A positive slope creates an ascending logistic curve (selectivity increases from 0 to 1 with increasing x), while a negative slope creates a descending logistic curve (selectivity decreases from 1 to 0 with increasing x).

Member Function Documentation

create_report_vectors()

template<typename Type >

virtual void fims_popdy::LogisticSelectivity< Type >::create_report_vectors ( std::map< std::string, fims::Vector< fims::Vector< Type > > > &  report_vectors )

inlinevirtual

Create a map of report vectors for the object. used to populate the report_vectors map in FisheryModelBase.

Reimplemented from fims_model_object::FIMSObject< Type >.

evaluate() [1/2]

template<typename Type >

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

inlinevirtual

Method of the logistic selectivity class that implements the logistic function from FIMS math.

\[ \frac{1.0}{ 1.0 + exp(-1.0 * slope (x - inflection\_point))} \]

The selectivity curve can be either ascending or descending depending on the sign of the slope parameter:

• Positive slope: ascending curve (selectivity increases from 0 to 1)
• Negative slope: descending curve (selectivity decreases from 1 to 0)

Parameters

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

Implements fims_popdy::SelectivityBase< Type >.

evaluate() [2/2]

template<typename Type >

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

inlinevirtual

Method of the logistic selectivity class that implements the logistic function from FIMS math.

\[ \frac{1.0}{ 1.0 + exp(-1.0 * slope (x - inflection\_point))} \]

The selectivity curve can be either ascending or descending depending on the sign of the slope parameter:

• Positive slope: ascending curve (selectivity increases from 0 to 1)
• Negative slope: descending curve (selectivity decreases from 1 to 0)

Parameters

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

Implements fims_popdy::SelectivityBase< Type >.

get_report_vector_count()

template<typename Type >

virtual void fims_popdy::LogisticSelectivity< Type >::get_report_vector_count ( std::map< std::string, size_t > &  report_vector_count )

inlinevirtual

Get the report vector count object. used to get the length of each report vector for populating the UncertaintyReportInfo struct in FisheryModelBase.

Reimplemented from fims_model_object::FIMSObject< Type >.

Member Data Documentation

inflection_point

template<typename Type >

fims::Vector<Type> fims_popdy::LogisticSelectivity< Type >::inflection_point

50% quantile of the value of the quantity of interest (x); e.g. age at which 50% of the fish are selected

slope

template<typename Type >

fims::Vector<Type> fims_popdy::LogisticSelectivity< Type >::slope

scalar multiplier of difference between quantity of interest value (x) and inflection_point. Positive values create an ascending curve (0 to 1), negative values create a descending curve (1 to 0).

---

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

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