Change API regarding convergence information #33
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
There is now a single function `lambertw` for computing the Lambert W function. It takes a keyword argument, `info`. If `info` is false, the default, then only the result of computation is returned. If it is `true` then a triple giving the result and info on convergence is returned.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #33 +/- ##
==========================================
+ Coverage 98.80% 99.40% +0.59%
==========================================
Files 1 1
Lines 168 168
==========================================
+ Hits 166 167 +1
+ Misses 2 1 -1 ☔ View full report in Codecov by Sentry. |
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.
There is now a single function
lambertwfor computing the Lambert W function. It takes a keyword argument,info. Ifinfois false, the default, then only the result of computation is returned. If it istruethen a triple giving the result and info on convergence is returned.In neither case is a warning or error explicitly raised.