-
Notifications
You must be signed in to change notification settings - Fork 20
1469 Correct nonageresolved indices in IDE-SECIR model #1472
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1472 +/- ##
==========================================
- Coverage 97.31% 97.30% -0.02%
==========================================
Files 187 187
Lines 16017 16017
==========================================
- Hits 15587 15585 -2
- Misses 430 432 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
reneSchm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice documentation for the new test. The only important comment is on line 278 regarding testing interactions between age groups.
| // age group and the population size as well as the initial values for the deaths and transitions are scaled by some | ||
| // factor. This way, the expected results for this model are determined by the results from the other test and the | ||
| // scaling factor. With this, we can check that the correct indices are used for each age group. | ||
| TEST(IdeSecirAgeres, checkSimulationFunctions) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you mean to use a new test suite, or do you want to reuse the one from above?
| TEST(IdeSecirAgeres, checkSimulationFunctions) | |
| TEST(TestIdeAgeres, checkSimulationFunctions) |
| // the second age group. | ||
| ScalarType baseline_scaling = 2.; | ||
|
|
||
| /*****************************************************************************************************************/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is a best practice to avoid C style comments, i.e. use // instead of /* */.
If you want to separate sections, IMO it is best to use text as titles, e.g.
// <section title>
But I won't stop you from getting fancy with added stars or hash signs.
| int Ri = get_state_flat_index(Eigen::Index(InfectionState::Recovered), group); | ||
| int Di = get_state_flat_index(Eigen::Index(InfectionState::Dead), group); | ||
| // The scheme of the ODE model for initialization is applied here. | ||
| populations[Eigen::Index(0)][Ri] = total_confirmed_cases[group] - populations[Eigen::Index(0)][ISyi] - |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Off topic, but if a value is used as much as this Eigen::Index(0), it helps readability to give it a name. E.g. const Eigen::Index init_time_point = 0, if I read the context correctly.
| // Model with whole population in second age group with index 1. Use baseline values scaled by baseline_scaling. | ||
| considered_group = 1; | ||
| std::vector<ScalarType> N_vec_group1 = {0., baseline_scaling * population_baseline}; | ||
| std::vector<ScalarType> deaths_vec_group1 = {0., baseline_scaling * deaths_baseline}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would have expected that the second test uses both populations to check that there are no unexpected interactions between age groups. With the current setup, any interactions between age groups vanishes (as the "other" age group is always 0), so in theory that could hide indexing errors.
Do you want to cover that case?
| // Set working parameters. | ||
| for (size_t group = 0; group < num_agegroups; group++) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This loop seems to be exactly the same as above, except for using model_group1. You could move some of the fairly lengthy setup into one or more functions (or lambda functions), so it is easier to spot that the setup is the same, and to make the test shorter.
| // Define vectors with expected results for first model. | ||
| int num_compartments = (int)mio::isecir::InfectionState::Count; | ||
| std::vector<ScalarType> secihurd_t0_group0(num_compartments * num_agegroups, 0.); | ||
| std::vector<ScalarType> secihurd_t1_group0(num_compartments * num_agegroups, 0.); | ||
| std::vector<ScalarType> transitions_t1_group0(num_transitions * num_agegroups, 0.); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found these additional vectors and the following copy-transform-copy very confusing. You can replace the copy and the checks (i.e. lines 353-402) by the following:
// Compare simulated compartments at time points t0 and t1.
for (Eigen::Index i = 0; i < (Eigen::Index)secihurd_simulated_group0.get_num_elements(); i++) {
EXPECT_NEAR(secihurd_simulated_group0[0][i], secihurd_t0_baseline[i], 1e-8);
EXPECT_NEAR(secihurd_simulated_group0[1][i], 0.0, 1e-8);
EXPECT_NEAR(secihurd_simulated_group1[0][i], 0.0, 1e-8);
EXPECT_NEAR(secihurd_simulated_group1[1][i], baseline_scaling * secihurd_t1_baseline[i], 1e-8);
}
ASSERT_EQ(transitions_t1_baseline.size() * 2, transitions_simulated_group0.get_num_elements());
// Compare simulated transitions with expected results at time point t1.
for (size_t i = 0; i < transitions_t1_baseline.size(); i++) {
const size_t age1 = i;
const size_t age2 = i + transitions_t1_baseline.size();
EXPECT_NEAR(transitions_simulated_group0.get_last_value()[age1], transitions_t1_baseline[i], 1e-8);
EXPECT_NEAR(transitions_simulated_group1.get_last_value()[age1], 0.0, 1e-8);
EXPECT_NEAR(transitions_simulated_group0.get_last_value()[age2], 0.0, 1e-8);
EXPECT_NEAR(transitions_simulated_group1.get_last_value()[age2], baseline_scaling * transitions_t1_baseline[i],
1e-8);
}
Changes and Information
In the IDE-SECIR model, two indices were not adapted for multiple age groups. This was corrected here and appropriate test was added to check the correctness of the ageresolved simulation.
Merge Request - Guideline Checklist
Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.
Checks by code author
Checks by code reviewer(s)
Closes #1469