Defines the model results data type. More...

#include <model_result.h>

Collaboration diagram for hgps::ModelResult:

Public Member Functions
	ModelResult ()=delete

	ModelResult (const unsigned int sample_size)
	Initialises a new instance of the ModelResult structure. More...

std::string	to_string () const noexcept
	Gets a string representation of this instance. More...

int	number_of_recyclable () const noexcept
	Gets the number of recycled population slots due to deaths and emigration. More...

Public Attributes
int	population_size {}
	Total population size. More...

IntegerGenderValue	number_alive {}
	The number of people alive in the population. More...

int	number_dead {}
	The number of dead in the population. More...

int	number_emigrated {}
	The number of emigrants in the population. More...

ResultByGender	average_age {}
	Average age of the population. More...

DALYsIndicator	indicators {}
	The DALYs indicator. More...

std::map< std::string, ResultByGender >	risk_ractor_average {}
	Average risk factors value in population. More...

std::map< std::string, ResultByGender >	disease_prevalence {}
	Average diseases prevalence value in population. More...

std::map< unsigned int, ResultByGender >	comorbidity {}
	Average comorbidity in population. More...

std::map< std::string, double >	metrics {}
	Simulation runtime metrics. More...

DataSeries	series
	The detailed time series data results. More...

Detailed Description

Defines the model results data type.

Constructor & Destructor Documentation

◆ ModelResult() [1/2]

hgps::ModelResult::ModelResult ( )

delete

◆ ModelResult() [2/2]

hgps::ModelResult::ModelResult ( const unsigned int sample_size )

Initialises a new instance of the ModelResult structure.

Parameters

sample_size The results sample size value

Member Function Documentation

◆ number_of_recyclable()

int hgps::ModelResult::number_of_recyclable ( ) const

noexcept

Gets the number of recycled population slots due to deaths and emigration.

Returns: Number of recycled population slots

Here is the call graph for this function:

◆ to_string()

std::string hgps::ModelResult::to_string ( ) const

noexcept

Gets a string representation of this instance.

Returns: The string representation

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ average_age

ResultByGender hgps::ModelResult::average_age {}

Average age of the population.

◆ comorbidity

std::map<unsigned int, ResultByGender> hgps::ModelResult::comorbidity {}

Average comorbidity in population.

◆ disease_prevalence

std::map<std::string, ResultByGender> hgps::ModelResult::disease_prevalence {}

Average diseases prevalence value in population.

◆ indicators

DALYsIndicator hgps::ModelResult::indicators {}

The DALYs indicator.

◆ metrics

std::map<std::string, double> hgps::ModelResult::metrics {}

Simulation runtime metrics.

◆ number_alive

IntegerGenderValue hgps::ModelResult::number_alive {}

The number of people alive in the population.

◆ number_dead

int hgps::ModelResult::number_dead {}

The number of dead in the population.

◆ number_emigrated

int hgps::ModelResult::number_emigrated {}

The number of emigrants in the population.

◆ population_size

int hgps::ModelResult::population_size {}

Total population size.

◆ risk_ractor_average

std::map<std::string, ResultByGender> hgps::ModelResult::risk_ractor_average {}

Average risk factors value in population.

◆ series

DataSeries hgps::ModelResult::series

The detailed time series data results.

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

HealthGPS/model_result.h
HealthGPS/model_result.cpp

Public Member Functions

Public Attributes