hgps::LiteHierarchicalModelDefinition Class Reference

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

#include <energy_balance_hierarchical_model.h>

Inheritance diagram for hgps::LiteHierarchicalModelDefinition:

Collaboration diagram for hgps::LiteHierarchicalModelDefinition:

Public Member Functions
	LiteHierarchicalModelDefinition (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 LiteHierarchicalModelDefinition class. More...
std::unique_ptr< HierarchicalLinearModel >	create_model () const override
	Construct a new EnergyBalanceHierarchicalModel from this definition. More...
Public Member Functions inherited from hgps::RiskFactorModelDefinition
virtual	~RiskFactorModelDefinition ()=default
	Destroys a RiskFactorModelDefinition instance. More...

Detailed Description

Defines the lite hierarchical linear model data type.

Constructor & Destructor Documentation

LiteHierarchicalModelDefinition()

hgps::LiteHierarchicalModelDefinition::LiteHierarchicalModelDefinition	(	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 LiteHierarchicalModelDefinition class.

Parameters

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< HierarchicalLinearModel > hgps::LiteHierarchicalModelDefinition::create_model ( ) const

overridevirtual

Construct a new EnergyBalanceHierarchicalModel from this definition.

Returns

A unique pointer to the new EnergyBalanceHierarchicalModel instance

Implements hgps::RiskFactorModelDefinition.

---

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

• HealthGPS/energy_balance_hierarchical_model.h
• HealthGPS/energy_balance_hierarchical_model.cpp