Skip to content
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

Allow finalsize C++ code sharing #146

Closed
pratikunterwegs opened this issue Feb 15, 2023 · 0 comments · Fixed by #150
Closed

Allow finalsize C++ code sharing #146

pratikunterwegs opened this issue Feb 15, 2023 · 0 comments · Fixed by #150
Assignees
Labels
Cleanup Clean up files or code for readability. Documentation Improvements or additions to documentation New feature New feature or request

Comments

@pratikunterwegs
Copy link
Collaborator

This issue is to request that the C++ solvers from {finalsize} should be exportable so that they can be used in other Rcpp-based packages. A template for how to do this can be found at this PR on the {epidemics} package: epiverse-trace/epidemics#3.

This would entail:

  1. Creating headers under 'inst/include/' which define a C++ namespace (also called 'finalsize'), which contains the solvers which are moved here;
  2. Creating (or auto-creating) a package header under 'inst/include/' that includes all other headers;
  3. Writing a wrapper function called ".final_size(...)" under a new source file 'src/finalsize.cpp' that wraps the solvers as well as any previous preparation steps (see Move finalsize specific element from solver function to main finalsize() function #68).
  4. Writing a small vignette that shows how to link other Rcpp packages with the header provided in {finalsize}.

This would not introduce any breaking changes.

This issue could work towards resolution of #68.

@pratikunterwegs pratikunterwegs added Documentation Improvements or additions to documentation New feature New feature or request Cleanup Clean up files or code for readability. labels Feb 15, 2023
@pratikunterwegs pratikunterwegs self-assigned this Feb 15, 2023
@pratikunterwegs pratikunterwegs changed the title Allow finalsize solver export Allow finalsize C++ code sharing Feb 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cleanup Clean up files or code for readability. Documentation Improvements or additions to documentation New feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant