Make nalgebra optional #270
Merged
Conversation
This file contains 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
The feature is enabled by default to avoid downstream breakage. Users can disable the default features to remove the nalgebra dependency at the cost of some distributions which rely on it. The distributions requiring nalgebra are (currently): - Dirichlet - Multinomial - MultivariateNormal - MultivariateStudent
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #270 +/- ##
=======================================
Coverage 90.62% 90.62%
=======================================
Files 50 50
Lines 11583 11585 +2
=======================================
+ Hits 10497 10499 +2
Misses 1086 1086 ☔ View full report in Codecov by Sentry. |
|
Thanks for this, looks good! |
This was referenced Sep 5, 2024
Merged
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.
Closes #196.
With this, users can remove the
nalgebradependency by changing:to
This will exclude all distributions depending on
nalgebrafrom compilation (and the public API):$ cargo public-api --no-default-features | grep -c nalgebra 0There has been some talk in the linked issue about adding a feature for multivariate distributions, but I think for now it's simple enough to hide all nalgebra-dependent types behind this flag. If it becomes necessary, this can still be changed.
The new feature is enabled by default to avoid breakage when upgrading the package, but it probably wouldn't be a big deal to disable it by default either.
MSRV-related note: The
dep:prefix requires 1.60.