Extended documentation on 3rdparty libraries and added minor code improvements - #1038
Open
volkm wants to merge 10 commits into
Open
Extended documentation on 3rdparty libraries and added minor code improvements#1038volkm wants to merge 10 commits into
volkm wants to merge 10 commits into
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The code changes are low-risk and internally consistent, with only minor documentation typos remaining to optionally fix.
Pull request overview
This PR improves Storm’s developer-facing documentation for third-party resources, consolidates optional CUDD includes behind a single adapter header, removes an unused (commented-out) GSPN model builder, and applies a few small correctness/quality fixes in the codebase.
Changes:
- Extended and updated documentation for adding/updating third-party dependencies (including HiGHS-related guidance).
- Consolidated CUDD C++ interface includes via a new
storm/adapters/cudd.hadapter header. - Removed the unused
ExplicitGspnModelBuilderand applied small fixes (stream flag restoration, minor comment/typo cleanups, CLI version output for HiGHS).
File summaries
| File | Description |
|---|---|
| src/storm/utility/OptionalRef.h | Minor doc comment punctuation fix (has_value() formatting). |
| src/storm/storage/dd/cudd/utility.h | Uses centralized CUDD adapter include. |
| src/storm/storage/dd/cudd/InternalCuddDdManager.h | Uses centralized CUDD adapter include. |
| src/storm/storage/dd/cudd/InternalCuddBdd.h | Uses centralized CUDD adapter include. |
| src/storm/storage/dd/cudd/InternalCuddAdd.h | Uses centralized CUDD adapter include. |
| src/storm/storage/dd/cudd/CuddAddIterator.h | Uses centralized CUDD adapter include. |
| src/storm/solver/Z3LpSolver.h | Comment typo fix (“necessary”). |
| src/storm/solver/SoplexLpSolver.h | Comment typo fix (“necessary”) and minor formatting. |
| src/storm/solver/GurobiLpSolver.h | Comment typo fix (“necessary”). |
| src/storm/modelchecker/results/ExplicitQualitativeCheckResult.cpp | Fixes stream flag save/restore to use out instead of std::cout. |
| src/storm/automata/HOAConsumerDAHeader.h | Clarifies rationale for exception-based early abort in header parsing. |
| src/storm/adapters/cudd.h | New adapter header wrapping CUDD includes behind STORM_HAVE_CUDD. |
| src/storm-gspn/builder/ExplicitGspnModelBuilder.h | Removed unused, commented-out builder header. |
| src/storm-gspn/builder/ExplicitGspnModelBuilder.cpp | Removed unused, commented-out builder implementation. |
| src/storm-gspn-cli/storm-gspn.cpp | Drops include of removed builder header. |
| src/storm-cli-utilities/print.cpp | Adds HiGHS linkage info to printVersion(). |
| resources/3rdparty/modernjson/README_STORM.md | Updates link to new/renamed third-party dependency documentation. |
| doc/developers.md | Adds pointer section to third-party resources documentation. |
| doc/3rdparty_dependencies.md | Major expansion of third-party resources documentation and update instructions. |
Review details
Suppressed comments (3)
doc/3rdparty_dependencies.md:13
- Grammar: “various other places needs updating” should use plural verb (“need updating”).
This issue also appears in the following locations of the same file:
- line 41
- line 68
doc/3rdparty_dependencies.md:41
- Grammar: “If packages exists” should be “If packages exist”.
doc/3rdparty_dependencies.md:68 - Typo: the resource is named “ExprTk” (as in the section header), but the text says “ExrtTk”.
- Files reviewed: 19/19 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
A couple of smaller things:
ExplicitGspnModelBuilderwhich was not used.