hgps::HierarchicalLinearModelDefinition Class Reference

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

#include <hierarchical_model_static.h>

Inheritance diagram for hgps::HierarchicalLinearModelDefinition:

Collaboration diagram for hgps::HierarchicalLinearModelDefinition:

Public Member Functions
	HierarchicalLinearModelDefinition (std::unordered_map< core::Identifier, LinearModel > linear_models, std::map< int, HierarchicalLevel > model_levels)
	Initialises a new instance of the HierarchicalLinearModelDefinition class. More...
std::unique_ptr< HierarchicalLinearModel >	create_model () const override
	Construct a new StaticHierarchicalLinearModel from this definition. More...
Public Member Functions inherited from hgps::RiskFactorModelDefinition
virtual	~RiskFactorModelDefinition ()=default
	Destroys a RiskFactorModelDefinition instance. More...

Detailed Description

Defines the full hierarchical linear model data type.

Constructor & Destructor Documentation

HierarchicalLinearModelDefinition()

hgps::HierarchicalLinearModelDefinition::HierarchicalLinearModelDefinition	(	std::unordered_map< core::Identifier, LinearModel >	linear_models,
		std::map< int, HierarchicalLevel >	model_levels
	)

Initialises a new instance of the HierarchicalLinearModelDefinition class.

Parameters

linear_models	The linear regression models equations
model_levels	The hierarchical model levels definition

Exceptions

std::invalid_argument

for empty arguments

Member Function Documentation

create_model()

std::unique_ptr< HierarchicalLinearModel > hgps::HierarchicalLinearModelDefinition::create_model ( ) const

overridevirtual

Construct a new StaticHierarchicalLinearModel from this definition.

Returns

A unique pointer to the new StaticHierarchicalLinearModel instance

Implements hgps::RiskFactorModelDefinition.

---

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

• HealthGPS/hierarchical_model_static.h
• HealthGPS/hierarchical_model_static.cpp