hgps::DynamicHierarchicalLinearModelDefinition Class Reference

Defines the dynamic hierarchical linear model data type. More...

#include <dynamic_hierarchical_linear_model.h>

Inheritance diagram for hgps::DynamicHierarchicalLinearModelDefinition:

Collaboration diagram for hgps::DynamicHierarchicalLinearModelDefinition:

Public Member Functions
	DynamicHierarchicalLinearModelDefinition (std::unique_ptr< RiskFactorSexAgeTable > expected, std::unique_ptr< std::unordered_map< core::Identifier, double > > expected_trend, std::unique_ptr< std::unordered_map< core::Identifier, int > > trend_steps, std::map< core::IntegerInterval, AgeGroupGenderEquation > equations, std::map< core::Identifier, core::Identifier > variables, const double boundary_percentage=0.05)
	Initialises a new instance of the DynamicHierarchicalLinearModelDefinition class.
std::unique_ptr< RiskFactorModel >	create_model () const override
	Construct a new DynamicHierarchicalLinearModel from this definition.
Public Member Functions inherited from hgps::RiskFactorAdjustableModelDefinition
	~RiskFactorAdjustableModelDefinition () override=default
	Destroys a RiskFactorAdjustableModelDefinition instance.
	RiskFactorAdjustableModelDefinition (std::unique_ptr< RiskFactorSexAgeTable > expected, std::unique_ptr< std::unordered_map< core::Identifier, double > > expected_trend, std::unique_ptr< std::unordered_map< core::Identifier, int > > trend_steps, TrendType trend_type=TrendType::Null)
	Constructs a new RiskFactorAdjustableModelDefinition instance.
Public Member Functions inherited from hgps::RiskFactorModelDefinition
virtual	~RiskFactorModelDefinition ()=default
	Destroys a RiskFactorModelDefinition instance.

Additional Inherited Members
Protected Attributes inherited from hgps::RiskFactorAdjustableModelDefinition
std::shared_ptr< RiskFactorSexAgeTable >	expected_
std::shared_ptr< std::unordered_map< core::Identifier, double > >	expected_trend_
std::shared_ptr< std::unordered_map< core::Identifier, int > >	trend_steps_
TrendType	trend_type_

Detailed Description

Defines the dynamic hierarchical linear model data type.

Constructor & Destructor Documentation

DynamicHierarchicalLinearModelDefinition()

hgps::DynamicHierarchicalLinearModelDefinition::DynamicHierarchicalLinearModelDefinition	(	std::unique_ptr< RiskFactorSexAgeTable >	expected,
		std::unique_ptr< std::unordered_map< core::Identifier, double > >	expected_trend,
		std::unique_ptr< std::unordered_map< core::Identifier, int > >	trend_steps,
		std::map< core::IntegerInterval, AgeGroupGenderEquation >	equations,
		std::map< core::Identifier, core::Identifier >	variables,
		const double	boundary_percentage = 0.05
	)

Initialises a new instance of the DynamicHierarchicalLinearModelDefinition class.

Parameters

expected	The expected values
expected_trend	The expected trend of risk factor values
trend_steps	The number of time steps to apply the trend
equations	The linear regression equations
variables	The factors delta variables mapping
boundary_percentage	The boundary percentage to sample

Exceptions

std::invalid_argument

for empty model equations definition

Member Function Documentation

create_model()

std::unique_ptr< RiskFactorModel > hgps::DynamicHierarchicalLinearModelDefinition::create_model ( ) const

overridevirtual

Construct a new DynamicHierarchicalLinearModel from this definition.

Returns

A unique pointer to the new DynamicHierarchicalLinearModel instance

Implements hgps::RiskFactorModelDefinition.

---

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

• HealthGPS/dynamic_hierarchical_linear_model.h
• HealthGPS/dynamic_hierarchical_linear_model.cpp