869 default values of agegroupgotoschoolwork abm parameters (#973)

khoanguyen-dev · reneSchm · commit 5f7fb0d5d81d · 2024-05-24T10:19:32.000+02:00
diff --git a/cpp/examples/abm_history_object.cpp b/cpp/examples/abm_history_object.cpp
@@ -72,6 +72,12 @@ int main()
     // Set same infection parameter for all age groups. For example, the incubation period is 4 days.
     world.parameters.get<mio::abm::IncubationPeriod>() = 4.;
 
+    // Set the age group the can go to school is AgeGroup(1) (i.e. 5-14)
+    world.parameters.get<mio::abm::AgeGroupGotoSchool>()[age_group_5_to_14] = true;
+    // Set the age group the can go to work is AgeGroup(2) and AgeGroup(3) (i.e. 15-34 and 35-59)
+    world.parameters.get<mio::abm::AgeGroupGotoWork>().set_multiple({age_group_15_to_34, age_group_35_to_59}, true);
+
+
     // There are 3 households for each household group.
     int n_households = 3;
 
diff --git a/cpp/examples/abm_minimal.cpp b/cpp/examples/abm_minimal.cpp
@@ -41,12 +41,9 @@ int main()
     world.parameters.get<mio::abm::IncubationPeriod>() = 4.;
 
     // Set the age group the can go to school is AgeGroup(1) (i.e. 5-14)
-    world.parameters.get<mio::abm::AgeGroupGotoSchool>()                    = false;
     world.parameters.get<mio::abm::AgeGroupGotoSchool>()[age_group_5_to_14] = true;
     // Set the age group the can go to work is AgeGroup(2) and AgeGroup(3) (i.e. 15-34 and 35-59)
-    world.parameters.get<mio::abm::AgeGroupGotoWork>()                     = false;
-    world.parameters.get<mio::abm::AgeGroupGotoWork>()[age_group_15_to_34] = true;
-    world.parameters.get<mio::abm::AgeGroupGotoWork>()[age_group_35_to_59] = true;
+    world.parameters.get<mio::abm::AgeGroupGotoWork>().set_multiple({age_group_15_to_34, age_group_35_to_59}, true);
 
     // Check if the parameters satisfy their contraints.
     world.parameters.check_constraints();
diff --git a/cpp/memilio/utils/custom_index_array.h b/cpp/memilio/utils/custom_index_array.h
@@ -1,7 +1,7 @@
 /* 
 * Copyright (C) 2020-2024 MEmilio
 *
-* Authors: Daniel Abele
+* Authors: Daniel Abele, Khoa Nguyen
 *
 * Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
 *
@@ -325,6 +325,18 @@ class CustomIndexArray
         return (Eigen::Index)flatten_index(index, m_dimensions);
     }
 
+    /**
+     * @brief Set multiple entries to the same value.
+     * @param indices A list of indices to be set to the same value.
+     * @param value The value to set.
+     */
+    void set_multiple(const std::vector<typename CustomIndexArray<Typ, Tags...>::Index>& indices, const Typ& value)
+    {
+        for (const auto& index : indices) {
+            m_y[get_flat_index(index)] = value;
+        }
+    }
+
 private:
     // Random Access Iterator for CustomIndexArray
     // To Do: As of Eigen 3.4, this is not needed anymore,
diff --git a/cpp/models/abm/parameters.h b/cpp/models/abm/parameters.h
@@ -513,9 +513,7 @@ struct AgeGroupGotoSchool {
     using Type = CustomIndexArray<bool, AgeGroup>;
     static Type get_default(AgeGroup num_agegroups)
     {
-        auto a         = Type(num_agegroups, false);
-        a[AgeGroup(1)] = true;
-        return a;
+        return Type(num_agegroups, false);
     }
     static std::string name()
     {
@@ -530,10 +528,7 @@ struct AgeGroupGotoWork {
     using Type = CustomIndexArray<bool, AgeGroup>;
     static Type get_default(AgeGroup num_agegroups)
     {
-        auto a         = Type(num_agegroups, false);
-        a[AgeGroup(2)] = true;
-        a[AgeGroup(3)] = true;
-        return a;
+        return Type(num_agegroups, false);
     }
     static std::string name()
     {
diff --git a/cpp/simulations/abm.cpp b/cpp/simulations/abm.cpp
@@ -462,6 +462,11 @@ void assign_infection_state(mio::abm::World& world, mio::abm::TimePoint t, doubl
 
 void set_parameters(mio::abm::Parameters params)
 {
+    // Set the age group the can go to school is AgeGroup(1) (i.e. 5-14)
+    params.get<mio::abm::AgeGroupGotoSchool>()[age_group_5_to_14] = true;
+    // Set the age group the can go to work is AgeGroup(2) and AgeGroup(3) (i.e. 15-34 and 35-59)
+    params.get<mio::abm::AgeGroupGotoWork>().set_multiple({age_group_15_to_34, age_group_35_to_59}, true);
+
     params.set<mio::abm::IncubationPeriod>({{mio::abm::VirusVariant::Count, mio::AgeGroup(num_age_groups)}, 4.});
 
     // Set protection level from high viral load. Information based on: https://doi.org/10.1093/cid/ciaa886
diff --git a/cpp/simulations/abm_braunschweig.cpp b/cpp/simulations/abm_braunschweig.cpp
@@ -392,6 +392,11 @@ void create_world_from_data(mio::abm::World& world, const std::string& filename,
 
 void set_parameters(mio::abm::Parameters params)
 {
+    // Set the age group the can go to school is AgeGroup(1) (i.e. 5-14)
+    params.get<mio::abm::AgeGroupGotoSchool>()[age_group_5_to_14] = true;
+    // Set the age group the can go to work is AgeGroup(2) and AgeGroup(3) (i.e. 15-34 and 35-59)
+    params.get<mio::abm::AgeGroupGotoWork>().set_multiple({age_group_15_to_34, age_group_35_to_59}, true);
+
     params.set<mio::abm::IncubationPeriod>({{mio::abm::VirusVariant::Count, mio::AgeGroup(num_age_groups)}, 4.});
 
     // Set protection level from high viral load. Information based on: https://doi.org/10.1093/cid/ciaa886
diff --git a/cpp/tests/test_abm_location.cpp b/cpp/tests/test_abm_location.cpp
@@ -66,6 +66,8 @@ TEST(TestLocation, reachCapacity)
     world.parameters
         .get<mio::abm::InfectedNoSymptomsToRecovered>()[{mio::abm::VirusVariant::Wildtype, age_group_15_to_34}] =
         2 * dt.days();
+    world.parameters.get<mio::abm::AgeGroupGotoSchool>().set_multiple({age_group_5_to_14}, true);
+    world.parameters.get<mio::abm::AgeGroupGotoWork>().set_multiple({age_group_15_to_34, age_group_35_to_59}, true);
 
     auto home_id   = world.add_location(mio::abm::LocationType::Home);
     auto school_id = world.add_location(mio::abm::LocationType::School);
diff --git a/cpp/tests/test_abm_person.cpp b/cpp/tests/test_abm_person.cpp
@@ -118,6 +118,8 @@ TEST(TestPerson, quarantine)
     infection_parameters
         .get<mio::abm::InfectedSymptomsToRecovered>()[{mio::abm::VirusVariant::Wildtype, age_group_35_to_59}] =
         0.5 * dt.days();
+    infection_parameters.get<mio::abm::AgeGroupGotoSchool>().set_multiple({age_group_5_to_14}, true);
+    infection_parameters.get<mio::abm::AgeGroupGotoWork>().set_multiple({age_group_15_to_34, age_group_35_to_59}, true);
 
     auto person     = make_test_person(home, age_group_35_to_59, mio::abm::InfectionState::InfectedSymptoms, t_morning,
                                        infection_parameters);
@@ -126,11 +128,11 @@ TEST(TestPerson, quarantine)
     person.get_tested(rng_person, t_morning, test_params);
 
     EXPECT_EQ(person.get_infection_state(t_morning), mio::abm::InfectionState::InfectedSymptoms);
-    EXPECT_EQ(mio::abm::go_to_work(rng_person, person, t_morning, dt, mio::abm::Parameters(num_age_groups)),
+    EXPECT_EQ(mio::abm::go_to_work(rng_person, person, t_morning, dt, infection_parameters),
               mio::abm::LocationType::Home);
     EXPECT_EQ(person.get_infection_state(t_morning + dt), mio::abm::InfectionState::Recovered);
     person.remove_quarantine();
-    EXPECT_EQ(mio::abm::go_to_work(rng_person, person, t_morning, dt, mio::abm::Parameters(num_age_groups)),
+    EXPECT_EQ(mio::abm::go_to_work(rng_person, person, t_morning, dt, infection_parameters),
               mio::abm::LocationType::Work);
 }
 
diff --git a/cpp/tests/test_abm_world.cpp b/cpp/tests/test_abm_world.cpp
@@ -185,6 +185,8 @@ TEST(TestWorld, evolveMigration) // TODO: this is not a unit test, this is a uni
         world.parameters
             .get<mio::abm::InfectedNoSymptomsToRecovered>()[{mio::abm::VirusVariant::Wildtype, age_group_15_to_34}] =
             2 * dt.days();
+        world.parameters.get<mio::abm::AgeGroupGotoSchool>().set_multiple({age_group_5_to_14}, true);
+        world.parameters.get<mio::abm::AgeGroupGotoWork>().set_multiple({age_group_15_to_34, age_group_35_to_59}, true);
 
         auto home_id   = world.add_location(mio::abm::LocationType::Home);
         auto school_id = world.add_location(mio::abm::LocationType::School);
diff --git a/cpp/tests/test_custom_index_array.cpp b/cpp/tests/test_custom_index_array.cpp
@@ -1,7 +1,7 @@
 /* 
 * Copyright (C) 2020-2024 MEmilio
 *
-* Authors: Daniel Abele
+* Authors: Daniel Abele, Khoa Nguyen
 *
 * Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
 *
@@ -380,3 +380,48 @@ TEST(CustomIndexArray, resize_one_dimension)
     ASSERT_EQ(array.size().indices, std::make_tuple(Tag0{3}, Tag1{2}));
     ASSERT_EQ(array.numel(), 6);
 }
+
+// Additional test for checking the set_multiple functionality
+TEST(CustomIndexArray, setMultiple_validIndices) {
+    using ArrayType = mio::CustomIndexArray<int, Dim1, Dim2>;
+    // Initialize with zeros
+    ArrayType array({mio::Index<Dim1>(3), Dim2::Count}, 0);
+
+    // Define indices to set
+    std::vector<ArrayType::Index> indices = {
+        {mio::Index<Dim1>(0), Dim2::Male},
+        {mio::Index<Dim1>(2), Dim2::Female}
+    };
+
+    // Set these indices to 42
+    array.set_multiple(indices, 42);
+
+    // Verify that the correct indices have been updated
+    EXPECT_EQ((array[{mio::Index<Dim1>(0), Dim2::Male}]), 42);
+    EXPECT_EQ((array[{mio::Index<Dim1>(2), Dim2::Female}]), 42);
+
+    // Verify that other indices are unchanged
+    EXPECT_EQ((array[{mio::Index<Dim1>(0), Dim2::Female}]), 0);
+    EXPECT_EQ((array[{mio::Index<Dim1>(1), Dim2::Male}]), 0);
+    EXPECT_EQ((array[{mio::Index<Dim1>(1), Dim2::Female}]), 0);
+    EXPECT_EQ((array[{mio::Index<Dim1>(2), Dim2::Male}]), 0);
+}
+
+TEST(CustomIndexArray, setMultiple_emptyIndices) {
+    using ArrayType = mio::CustomIndexArray<int, Dim1, Dim2>;
+    // Initialize with fives
+    ArrayType array({mio::Index<Dim1>(2), Dim2::Count}, 5);
+
+    // Empty vector of indices
+    std::vector<ArrayType::Index> indices;
+
+    // Attempt to set multiple indices to 42
+    array.set_multiple(indices, 42);
+
+    // Verify that all entries remain unchanged
+    for (int age = 0; age < 2; ++age) {
+        for (int gender = 0; gender < static_cast<int>(Dim2::Count); ++gender) {
+            EXPECT_EQ((array[{mio::Index<Dim1>(age), static_cast<Dim2>(gender)}]), 5);
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -513,9 +513,7 @@ struct AgeGroupGotoSchool {`
`513`	`513`	`using Type = CustomIndexArray<bool, AgeGroup>;`
`514`	`514`	`static Type get_default(AgeGroup num_agegroups)`
`515`	`515`	`{`
`516`		`- auto a = Type(num_agegroups, false);`
`517`		`- a[AgeGroup(1)] = true;`
`518`		`- return a;`
	`516`	`+ return Type(num_agegroups, false);`
`519`	`517`	`}`
`520`	`518`	`static std::string name()`
`521`	`519`	`{`
`@@ -530,10 +528,7 @@ struct AgeGroupGotoWork {`
`530`	`528`	`using Type = CustomIndexArray<bool, AgeGroup>;`
`531`	`529`	`static Type get_default(AgeGroup num_agegroups)`
`532`	`530`	`{`
`533`		`- auto a = Type(num_agegroups, false);`
`534`		`- a[AgeGroup(2)] = true;`
`535`		`- a[AgeGroup(3)] = true;`
`536`		`- return a;`
	`531`	`+ return Type(num_agegroups, false);`
`537`	`532`	`}`
`538`	`533`	`static std::string name()`
`539`	`534`	`{`