fims_popdy::Population< Type > Struct Template Reference

Population class. Contains subpopulations that are divided into generic partitions (e.g., sex, area). More...

#include <population.hpp>

Inheritance diagram for fims_popdy::Population< Type >:

Public Member Functions
	Population ()
	Constructor.
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.
virtual void	get_report_vector_count (std::map< std::string, size_t > &report_vector_count)
	Get the report vector count object.
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
size_t	n_years
size_t	n_ages
size_t	n_fleets
fims::Vector< Type >	log_init_naa
fims::Vector< Type >	log_M
fims::Vector< Type >	proportion_female
fims::Vector< Type >	log_f_multiplier
fims::Vector< Type >	spawning_biomass_ratio
fims::Vector< Type >	M
fims::Vector< Type >	f_multiplier
fims::Vector< double >	ages
fims::Vector< double >	years
int	recruitment_id = -999
	recruitment
std::shared_ptr< fims_popdy::RecruitmentBase< Type > >	recruitment
int	growth_id = -999
std::shared_ptr< fims_popdy::GrowthBase< Type > >	growth
int	maturity_id = -999
std::shared_ptr< fims_popdy::MaturityBase< Type > >	maturity
std::set< uint32_t >	fleet_ids
std::vector< std::shared_ptr< fims_popdy::Fleet< Type > > >	fleets
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

Static Public Attributes
static uint32_t	id_g = 0

Detailed Description

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

Population class. Contains subpopulations that are divided into generic partitions (e.g., sex, area).

Member Function Documentation

create_report_vectors()

template<typename Type >

virtual void fims_popdy::Population< 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.

Reimplemented from fims_model_object::FIMSObject< Type >.

get_report_vector_count()

template<typename Type >

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

inlinevirtual

Get the report vector count object.

Reimplemented from fims_model_object::FIMSObject< Type >.

Member Data Documentation

ages

template<typename Type >

fims::Vector<double> fims_popdy::Population< Type >::ages

vector of the ages for referencing

f_multiplier

template<typename Type >

fims::Vector<Type> fims_popdy::Population< Type >::f_multiplier

transformed parameter: vector of annual fishing mortality multipliers to scale total mortality of all fleets

fleet_ids

template<typename Type >

std::set<uint32_t> fims_popdy::Population< Type >::fleet_ids

id of fleet model object

fleets

template<typename Type >

std::vector<std::shared_ptr<fims_popdy::Fleet<Type> > > fims_popdy::Population< Type >::fleets

shared pointer to fleet module

growth

template<typename Type >

std::shared_ptr<fims_popdy::GrowthBase<Type> > fims_popdy::Population< Type >::growth

shared pointer to growth module

growth_id

template<typename Type >

int fims_popdy::Population< Type >::growth_id = -999

id of growth model object

id_g

template<class Type >

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

static

reference id for population object

log_f_multiplier

template<typename Type >

fims::Vector<Type> fims_popdy::Population< Type >::log_f_multiplier

estimated parameter: vector of annual fishing mortality multipliers to scale total mortality of all fleets

log_init_naa

template<typename Type >

fims::Vector<Type> fims_popdy::Population< Type >::log_init_naa

estimated parameter: natural log of numbers at age

log_M

template<typename Type >

fims::Vector<Type> fims_popdy::Population< Type >::log_M

estimated parameter: natural log of Natural Mortality

M

template<typename Type >

fims::Vector<Type> fims_popdy::Population< Type >::M

transformed parameter: natural mortality

maturity

template<typename Type >

std::shared_ptr<fims_popdy::MaturityBase<Type> > fims_popdy::Population< Type >::maturity

shared pointer to maturity module

maturity_id

template<typename Type >

int fims_popdy::Population< Type >::maturity_id = -999

id of maturity model object

n_ages

template<typename Type >

size_t fims_popdy::Population< Type >::n_ages

total number of ages in the population

n_fleets

template<typename Type >

size_t fims_popdy::Population< Type >::n_fleets

total number of fleets in the fishery

n_years

template<typename Type >

size_t fims_popdy::Population< Type >::n_years

total number of years in the fishery

proportion_female

template<typename Type >

fims::Vector<Type> fims_popdy::Population< Type >::proportion_female

Initial value:

= fims::Vector<Type>(
      1, static_cast<Type>(0.5))

proportion female by age

recruitment

template<typename Type >

std::shared_ptr<fims_popdy::RecruitmentBase<Type> > fims_popdy::Population< Type >::recruitment

shared pointer to recruitment module

recruitment_id

template<typename Type >

int fims_popdy::Population< Type >::recruitment_id = -999

recruitment

id of recruitment model object

spawning_biomass_ratio

template<typename Type >

fims::Vector<Type> fims_popdy::Population< Type >::spawning_biomass_ratio

estimated parameter: vector of annual fishing mortality multipliers to scale total mortality of all fleets

years

template<typename Type >

fims::Vector<double> fims_popdy::Population< Type >::years

vector of years for referencing

---

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

• inst/include/population_dynamics/population/population.hpp