lct_populations.h

Go to the documentation of this file.

/*
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Lena Ploetzke
*
* 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_EPI_LCT_POPULATIONS_H
#define MIO_EPI_LCT_POPULATIONS_H
 
#include "memilio/config.h" // IWYU pragma: keep
#include "memilio/math/eigen.h" // IWYU pragma: keep
#include "memilio/epidemiology/lct_infection_state.h" // IWYU pragma: keep for ease of use
#include "memilio/utils/metaprogramming.h"
#include "memilio/utils/type_list.h"
#include "memilio/utils/uncertain_value.h"
#include <cstddef>
 
namespace mio
{
 
template <typename FP, class... LctStates>
class LctPopulations
{
public:
    using Type                         = UncertainValue<FP>;
    using InternalArrayType            = Eigen::Array<Type, Eigen::Dynamic, 1>;
    using LctStatesGroups              = TypeList<LctStates...>;
    static size_t constexpr num_groups = sizeof...(LctStates); 
    static_assert(num_groups >= 1, "The number of LctStates provided should be at least one.");
 
    LctPopulations()
        : m_y(InternalArrayType::Constant(get_count(), UncertainValue<FP>(0.0)))
    {
    }
 
    size_t get_num_compartments() const
    {
        return m_y.size();
    }
 
    auto const& array() const
    {
        return m_y;
    }
    auto& array()
    {
        return m_y;
    }
 
    Type& operator[](size_t index)
    {
        assert(index < static_cast<size_t>(m_y.size()));
        return m_y[index];
    }
 
    template <size_t Group>
    size_t get_first_index_of_group() const
    {
        static_assert((Group < num_groups) && (Group >= 0), "The template parameter Group should be valid.");
        if constexpr (Group == 0) {
            return 0;
        }
        else {
            return get_first_index_of_group<Group - 1>() + type_at_index_t<Group - 1, LctStatesGroups>::Count;
        }
    }
    inline Eigen::VectorX<FP> get_compartments() const
    {
        return m_y.template cast<FP>();
    }
 
    template <size_t Group>
    FP get_group_total() const
    {
        return m_y.template cast<FP>()
            .segment(get_first_index_of_group<Group>(), type_at_index_t<Group, LctStatesGroups>::Count)
            .sum();
    }
 
    FP get_total() const
    {
        return m_y.template cast<FP>().sum();
    }
 
    bool apply_constraints()
    {
        bool corrected = false;
        for (int i = 0; i < m_y.size(); i++) {
            if (m_y[i] < 0.0) {
                if (m_y[i] > -1e-10) {
                    log_warning("Constraint check: Compartment number {} changed from {} to {}", i, m_y[i], 0);
                }
                else {
                    log_error("Constraint check: Compartment number {} changed from {} to {}", i, m_y[i], 0);
                }
                m_y[i]    = 0.;
                corrected = true;
            }
        }
        return corrected;
    }
 
    bool check_constraints() const
    {
        if ((m_y < 0.0).any()) {
            log_error("Constraint check: At least one compartment size is smaller {}.", 0);
            return true;
        }
        return false;
    }
 
private:
    template <size_t Group = 0>
    [[nodiscard]] static size_t get_count()
    {
        size_t count = 0;
        if constexpr (Group < num_groups) {
            count = type_at_index_t<Group, LctStatesGroups>::Count + get_count<Group + 1>();
        }
        return count;
    }
 
    InternalArrayType m_y{}; //< An array containing the number of people in the groups.
};
 
} // namespace mio
 
#endif // MIO_EPI_LCT_POPULATIONS_H