hgps::StaticHierarchicalLinearModelDefinition Class Reference

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

#include <static_hierarchical_linear_model.h>

Inheritance diagram for hgps::StaticHierarchicalLinearModelDefinition:

Collaboration diagram for hgps::StaticHierarchicalLinearModelDefinition:

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

Detailed Description

Defines the full hierarchical linear model data type.

Constructor & Destructor Documentation

StaticHierarchicalLinearModelDefinition()

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

Initialises a new instance of the StaticHierarchicalLinearModelDefinition 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< RiskFactorModel > hgps::StaticHierarchicalLinearModelDefinition::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/static_hierarchical_linear_model.h
• HealthGPS/static_hierarchical_linear_model.cpp