1370-1 Move function definitions from .cpp to header for upcoming templatization #1374

julianlitz · 2025-09-15T14:11:30Z

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

Moved IO functions from source to header file, such that they can be templated

If need be, add additional information and what the reviewer should look out for in particular:

Nothing in the implementation has changed
Forward declaration of in .cpp remaining functions
Lay foundation to resolve issue Add support for reading templated SECIR models from JSON data #1370

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

Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
New code adheres to coding guidelines
No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
Tests are added for new functionality and a local test run was successful (with and without OpenMP)
Appropriate documentation within the code (Doxygen) for new functionality has been added in the code
Appropriate external documentation (ReadTheDocs) for new functionality has been added to the online documentation
Proper attention to licenses, especially no new third-party software with conflicting license has been added
(For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

Corresponding issue(s) is/are linked and addressed
Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

julianlitz · 2025-09-16T08:41:18Z

cpp/memilio/io/mobility_io.cpp

-#include "memilio/math/eigen.h"
-#include "memilio/utils/logging.h"
-
-#ifdef MEMILIO_HAS_HDF5
-#include "memilio/io/hdf5_cpp.h"
-#endif // MEMILIO_HAS_HDF5
-
-#include <iostream>
-#include <fstream>
-#include <string>
-#include <vector>


Includes are now needed in header instead.

julianlitz · 2025-09-16T08:41:48Z

cpp/memilio/io/mobility_io.h

 * @param filename name of file to be read
 */
-IOResult<Eigen::MatrixXd> read_mobility_formatted(const std::string& filename);
+template <typename FP = ScalarType>


Add a dummy template to be able to move it to the header without conflicts.

julianlitz · 2025-09-16T08:42:15Z

cpp/memilio/io/mobility_io.h

 IOResult<void> save_edges(const std::vector<std::vector<TimeSeries<ScalarType>>>& ensemble_edges,
                          const std::vector<std::pair<int, int>>& pairs_edges, const fs::path& result_dir,
-                          bool save_single_runs = true, bool save_percentiles = true);
+                          bool save_single_runs = true, bool save_percentiles = true)


Ensure keeping default setting
bool save_percentiles = true

julianlitz · 2025-09-16T08:43:16Z

cpp/models/ode_secir/parameters_io.h

+// Forward declaration of get_region_id
+int get_region_id(int id);


Add forward declaration for in .cpp remaining functions.

julianlitz · 2025-09-16T08:43:53Z

cpp/models/ode_secirvvs/parameters_io.h

 IOResult<void> read_confirmed_cases_data(
-    std::string const& path, std::vector<int> const& vregion, Date date, std::vector<std::vector<double>>& num_Exposed,
-    std::vector<std::vector<double>>& num_InfectedNoSymptoms, std::vector<std::vector<double>>& num_InfectedSymptoms,
-    std::vector<std::vector<double>>& num_InfectedSevere, std::vector<std::vector<double>>& num_icu,
-    std::vector<std::vector<double>>& num_death, std::vector<std::vector<double>>& num_rec,
-    const std::vector<std::vector<int>>& t_Exposed, const std::vector<std::vector<int>>& t_InfectedNoSymptoms,
-    const std::vector<std::vector<int>>& t_InfectedSymptoms, const std::vector<std::vector<int>>& t_InfectedSevere,
-    const std::vector<std::vector<int>>& t_InfectedCritical, const std::vector<std::vector<double>>& mu_C_R,
-    const std::vector<std::vector<double>>& mu_I_H, const std::vector<std::vector<double>>& mu_H_U,
-    const std::vector<double>& scaling_factor_inf);
+    const std::vector<ConfirmedCasesDataEntry>& rki_data, std::vector<int> const& vregion, Date date,


Swapped two function declarations here.

Define A first.
Then define B which uses A.

julianlitz · 2025-09-16T08:44:22Z

cpp/models/ode_secirvvs/parameters_io.h

 IOResult<void> read_confirmed_cases_data_fix_recovered(const std::vector<ConfirmedCasesDataEntry>& rki_data,
                                                       std::vector<int> const& vregion, Date date,
-                                                       std::vector<std::vector<double>>& vnum_rec, double delay = 14.);
+                                                       std::vector<std::vector<double>>& vnum_rec, double delay = 14.0)


Ensure keeping default parameter
double delay = 14.0

julianlitz · 2025-09-16T08:45:13Z

pycode/memilio-simulation/memilio/simulation/bindings/models/osecir.cpp

+                                              decltype(mio::read_mobility_plain<double>)>(
+                mobility_data_file, params_graph, mobile_comp, contact_locations_size, mio::read_mobility_plain<double>,
+                weights);


Pycode explicitly needs these double template parameters.

julianlitz · 2025-09-16T08:46:25Z

cpp/memilio/io/result_io.h

+template <typename FP = ScalarType>
+IOResult<void> save_result(const std::vector<TimeSeries<ScalarType>>& results, const std::vector<int>& ids,
+                           int num_groups, const std::string& filename)


Be careful if names are different in .h and .cpp.
Here result -> results differs.

julianlitz added 4 commits September 15, 2025 12:27

Move from source to header

6557812

I like to move it move it

e9c2cbc

Pycode templates

24ec698

mio::read_mobility_plain<double>

71833e4

julianlitz commented Sep 16, 2025

View reviewed changes

julianlitz self-assigned this Sep 16, 2025

julianlitz added loc::backend This issue concerns the C++ backend implementation. class::improvement Cleanup that doesn't affect functionality labels Sep 16, 2025

julianlitz mentioned this pull request Sep 16, 2025

1370-2 Add support for reading templated SECIR models from JSON data #1375

Open

13 tasks

julianlitz requested review from MaxBetzDLR and reneSchm September 16, 2025 09:39

MaxBetzDLR added this to MEmilio: Equation-Based-Models Development Oct 9, 2025

MaxBetzDLR moved this to 👀 Review in MEmilio: Equation-Based-Models Development Oct 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

1370-1 Move function definitions from .cpp to header for upcoming templatization #1374

1370-1 Move function definitions from .cpp to header for upcoming templatization #1374

Uh oh!

julianlitz commented Sep 15, 2025 •

edited

Loading

Uh oh!

julianlitz Sep 16, 2025

Uh oh!

julianlitz Sep 16, 2025

Uh oh!

julianlitz Sep 16, 2025

Uh oh!

julianlitz Sep 16, 2025

Uh oh!

julianlitz Sep 16, 2025

Uh oh!

julianlitz Sep 16, 2025

Uh oh!

julianlitz Sep 16, 2025

Uh oh!

julianlitz Sep 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		// Forward declaration of get_region_id
		int get_region_id(int id);

1370-1 Move function definitions from .cpp to header for upcoming templatization #1374

Are you sure you want to change the base?

1370-1 Move function definitions from .cpp to header for upcoming templatization #1374

Uh oh!

Conversation

julianlitz commented Sep 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes and Information

Merge Request - Guideline Checklist

Checks by code author

Checks by code reviewer(s)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

julianlitz commented Sep 15, 2025 •

edited

Loading