household.h

Go to the documentation of this file.

/*
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Daniel Abele, Sascha Korf, Khoa Nguyen
*
* Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
#ifndef MIO_ABM_HOUSEHOLD_H
#define MIO_ABM_HOUSEHOLD_H
 
#include "abm/model.h"
#include "memilio/epidemiology/age_group.h"
#include "memilio/utils/custom_index_array.h"
#include <numeric>
#include <vector>
 
namespace mio
{
namespace abm
{
 
class HouseholdMember
{
public:
    HouseholdMember(size_t num_agegroups)
        : m_age_weights({AgeGroup(num_agegroups)}, 0)
    {
    }
 
    void set_age_weight(mio::AgeGroup age_group, int weight)
    {
        assert(age_group < m_age_weights.size<mio::AgeGroup>());
        m_age_weights[age_group] = weight;
    }
 
    const CustomIndexArray<int, mio::AgeGroup>& get_age_weights() const
    {
        return m_age_weights;
    }
 
private:
    CustomIndexArray<int, mio::AgeGroup> m_age_weights; 
};
 
class Household
{
public:
    Household()
        : m_household_member_list()
    {
        m_number_of_members = 0;
        m_space_per_member  = 0;
    }
 
    int get_total_number_of_members() const
    {
        return m_number_of_members;
    }
 
    void set_space_per_member(int space_per_member)
    {
        m_space_per_member = space_per_member;
    }
 
    int get_space_per_member() const
    {
        return m_space_per_member;
    }
 
    const std::vector<std::tuple<HouseholdMember, int>>& get_members() const
    {
        return m_household_member_list;
    }
 
    void add_members(HouseholdMember household_member, int number_of_members);
 
private:
    int m_number_of_members; 
    int m_space_per_member; 
    std::vector<std::tuple<HouseholdMember, int>> m_household_member_list; 
};
 
class HouseholdGroup
{
public:
    HouseholdGroup()
        : m_household_list()
    {
        m_number_of_households = 0;
    }
 
    int get_total_number_of_households() const
    {
        return m_number_of_households;
    }
 
    const std::vector<std::tuple<Household, int>>& get_households() const
    {
        return m_household_list;
    }
 
    void add_households(Household household, int number_of_households);
 
private:
    int m_number_of_households; 
    std::vector<std::tuple<Household, int>> m_household_list; 
};
 
void add_household_to_model(Model& model, const Household& household);
 
void add_household_group_to_model(Model& model, const HouseholdGroup& household_group);
 
} // namespace abm
} // namespace mio
 
#endif //MIO_ABM_HOUSEHOLD_H