clarify pinv documentation #29793
Merged
clarify pinv documentation #29793
Conversation
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
The `pinv` documentation falsely implied that it discarded singular values `σ > tol`, when in fact it discards `σ > tol max(σ)`. This PR corrects the docstring. (`σ > tol max(σ)` is a good behavior! `tol` should be a dimensionless quantity that doesn't depend on the overall scaling/units of the matrix.)
stevengj
added
docs
andreasnoack
approved these changes
Oct 24, 2018
|
Let's also rename it to Though probably not in this PR, we may want to make it a keyword arg (to keep it consistent with |
KristofferC
pushed a commit
that referenced
this pull request
Oct 29, 2018
* clarify pinv documentation The `pinv` documentation falsely implied that it discarded singular values `σ > tol`, when in fact it discards `σ > tol max(σ)`. This PR corrects the docstring. (`σ > tol max(σ)` is a good behavior! `tol` should be a dimensionless quantity that doesn't depend on the overall scaling/units of the matrix.) * rename tol -> rtol (cherry picked from commit 2996521)
KristofferC
pushed a commit
that referenced
this pull request
Feb 11, 2019
* clarify pinv documentation The `pinv` documentation falsely implied that it discarded singular values `σ > tol`, when in fact it discards `σ > tol max(σ)`. This PR corrects the docstring. (`σ > tol max(σ)` is a good behavior! `tol` should be a dimensionless quantity that doesn't depend on the overall scaling/units of the matrix.) * rename tol -> rtol (cherry picked from commit 2996521)
KristofferC
pushed a commit
that referenced
this pull request
Feb 20, 2020
* clarify pinv documentation The `pinv` documentation falsely implied that it discarded singular values `σ > tol`, when in fact it discards `σ > tol max(σ)`. This PR corrects the docstring. (`σ > tol max(σ)` is a good behavior! `tol` should be a dimensionless quantity that doesn't depend on the overall scaling/units of the matrix.) * rename tol -> rtol (cherry picked from commit 2996521)
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.
The
pinvdocumentation falsely implied that it discarded singular valuesσ ≤ tol, when in fact it discardsσ ≤ tol max(σ). This PR corrects the docstring.(
σ ≤ tol max(σ)is a good criterion!tolshould be a dimensionless quantity that doesn't depend on the overall scaling/units of the matrix. I was relieved when I checked the source code and verified thattolwas dimensionless.)