hgps::EnergyBalanceModelDefinition Class Reference

Defines the energy balance model data type. More...

#include <energy_balance_model.h>

Inheritance diagram for hgps::EnergyBalanceModelDefinition:

Collaboration diagram for hgps::EnergyBalanceModelDefinition:

Public Member Functions
	EnergyBalanceModelDefinition (std::unordered_map< core::Identifier, double > energy_equation, std::unordered_map< core::Identifier, std::pair< double, double >> nutrient_ranges, std::unordered_map< core::Identifier, std::map< core::Identifier, double >> nutrient_equations, std::unordered_map< core::Identifier, std::optional< double >> food_prices, std::unordered_map< core::Gender, std::vector< double >> age_mean_height)
	Initialises a new instance of the EnergyBalanceModelDefinition class. More...
std::unique_ptr< HierarchicalLinearModel >	create_model () const override
	Construct a new EnergyBalanceModel from this definition. More...
Public Member Functions inherited from hgps::RiskFactorModelDefinition
virtual	~RiskFactorModelDefinition ()=default
	Destroys a RiskFactorModelDefinition instance. More...

Detailed Description

Defines the energy balance model data type.

Constructor & Destructor Documentation

EnergyBalanceModelDefinition()

hgps::EnergyBalanceModelDefinition::EnergyBalanceModelDefinition	(	std::unordered_map< core::Identifier, double >	energy_equation,
		std::unordered_map< core::Identifier, std::pair< double, double >>	nutrient_ranges,
		std::unordered_map< core::Identifier, std::map< core::Identifier, double >>	nutrient_equations,
		std::unordered_map< core::Identifier, std::optional< double >>	food_prices,
		std::unordered_map< core::Gender, std::vector< double >>	age_mean_height
	)

Initialises a new instance of the EnergyBalanceModelDefinition class.

Parameters

energy_equation	The energy coefficients for each nutrient
nutrient_ranges	The minimum and maximum nutrient values
nutrient_equations	The nutrient coefficients for each food group
food_prices	The unit price for each food group
age_mean_height	The mean height at all ages (male and female)

Exceptions

std::invalid_argument

for empty arguments

Member Function Documentation

create_model()

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

overridevirtual

Construct a new EnergyBalanceModel from this definition.

Returns

A unique pointer to the new EnergyBalanceModel instance

Implements hgps::RiskFactorModelDefinition.

---

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

• HealthGPS/energy_balance_model.h
• HealthGPS/energy_balance_model.cpp