Make most dependencies private; document dependencies with graphviz#183
Merged
Make most dependencies private; document dependencies with graphviz#183
Conversation
- Added a figure to the documentation for default dependencies of the ipc::toolkit library. - Updated GraphViz configuration to include transparent backgrounds and Menlo font. - Refactored BVH class to use unique_ptr to hide SimpleBVH - Updated Sweep and Prune and Sweep and Tiniest Queue classes to use a Pimpl pattern for encapsulation. - Change potential.tpp to potential.cpp file to hide implementation details.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #183 +/- ##
==========================================
- Coverage 96.25% 96.24% -0.02%
==========================================
Files 104 105 +1
Lines 7991 8064 +73
==========================================
+ Hits 7692 7761 +69
- Misses 299 303 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the ipc::toolkit library to make most dependencies private rather than public, reducing the exposure of implementation details to downstream consumers. It also adds GraphViz documentation showing the library's dependency structure.
- Implements Pimpl (Pointer to Implementation) pattern for BVH, SweepAndPrune, and SweepAndTiniestQueue classes
- Converts potential.tpp template implementation file to potential.cpp to hide implementation details
- Updates CMake configuration to make dependencies private and adds explicit dependencies for tests and Python bindings
Reviewed Changes
Copilot reviewed 21 out of 23 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/src/tests/candidates/test_normals.cpp | Improves test code with cleaner matrix initialization and clearer lambda parameter naming |
| tests/CMakeLists.txt | Adds explicit dependencies for libigl and OneTBB that tests require |
| src/ipc/potentials/ | Converts template implementation to compiled source and adds required includes |
| src/ipc/broad_phase/ | Implements Pimpl pattern to hide scalable_ccd and SimpleBVH dependencies |
| python/CMakeLists.txt | Adds explicit dependencies for Python bindings |
| docs/ | Adds dependency graph documentation with improved GraphViz styling |
| CMakeLists.txt | Changes most dependencies from PUBLIC to PRIVATE linkage |
Comments suppressed due to low confidence (1)
cmake/recipes/abseil.cmake:15
- The Abseil version '20250512.1' appears to be from May 2025, which is in the future relative to my knowledge cutoff of January 2025. Please verify this version exists or use a known stable version like '20240116.2'.
CPMAddPackage("gh:abseil/abseil-cpp#20250512.1")
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
20250512.1Type of change