hgps::StaticHierarchicalLinearModel Class Reference

Implements the static hierarchical linear model type. More...

#include <static_hierarchical_linear_model.h>

Inheritance diagram for hgps::StaticHierarchicalLinearModel:

Collaboration diagram for hgps::StaticHierarchicalLinearModel:

Public Member Functions
	StaticHierarchicalLinearModel (const std::unordered_map< core::Identifier, LinearModel > &models, const std::map< int, HierarchicalLevel > &levels)
	Initialises a new instance of the StaticHierarchicalLinearModel class.
RiskFactorModelType	type () const noexcept override
	Gets the model type identifier.
std::string	name () const noexcept override
	Gets the model name.
void	generate_risk_factors (RuntimeContext &context) override
	Generates the initial risk factors for a population and newborns.
void	update_risk_factors (RuntimeContext &context) override
	Update risk factors for population.
Public Member Functions inherited from hgps::RiskFactorModel
virtual	~RiskFactorModel ()=default
	Destroys a RiskFactorModel instance.

Detailed Description

Implements the static hierarchical linear model type.

The static model is used to initialise the virtual population, the model uses principal component analysis for residual normalisation.

Constructor & Destructor Documentation

StaticHierarchicalLinearModel()

hgps::StaticHierarchicalLinearModel::StaticHierarchicalLinearModel	(	const std::unordered_map< core::Identifier, LinearModel > &	models,
		const std::map< int, HierarchicalLevel > &	levels
	)

Initialises a new instance of the StaticHierarchicalLinearModel class.

Parameters

models	The model equations
levels	The hierarchical model level definition

Member Function Documentation

generate_risk_factors()

void hgps::StaticHierarchicalLinearModel::generate_risk_factors ( RuntimeContext &  context )

overridevirtual

Generates the initial risk factors for a population and newborns.

Parameters

context

The simulation run-time context

Implements hgps::RiskFactorModel.

Here is the call graph for this function:

name()

std::string hgps::StaticHierarchicalLinearModel::name ( ) const

overridevirtualnoexcept

Gets the model name.

Returns

The human-readable model name

Implements hgps::RiskFactorModel.

type()

RiskFactorModelType hgps::StaticHierarchicalLinearModel::type ( ) const

overridevirtualnoexcept

Gets the model type identifier.

Returns

The module type identifier

Implements hgps::RiskFactorModel.

update_risk_factors()

void hgps::StaticHierarchicalLinearModel::update_risk_factors ( RuntimeContext &  context )

overridevirtual

Update risk factors for population.

Parameters

context

The simulation run-time context

Implements hgps::RiskFactorModel.

Here is the call graph for this function:

---

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

• HealthGPS/static_hierarchical_linear_model.h
• HealthGPS/static_hierarchical_linear_model.cpp