Improve Cholesky docstrings #39964
Merged
Improve Cholesky docstrings #39964
+49
−4
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 `p` object wasn't even documented.
nalimilan
added
docs
nalimilan
commented
Mar 9, 2021
| @@ -35,7 +35,10 @@ positive definite matrix `A`. This is the return type of [`cholesky`](@ref), | |||
| the corresponding matrix factorization function. | |||
| The triangular Cholesky factor can be obtained from the factorization `F::Cholesky` | |||
| via `F.L` and `F.U`. | |||
| via `F.L` and `F.U`, where `A ≈ F.U' * F.U ≈ F.L * F.L'`. | |||
There was a problem hiding this comment.
Examples use == but I imagine only ≈ holds generally? Or maybe this may not even be exactly the case?
dkarrasch
reviewed
Mar 9, 2021
Co-authored-by: Daniel Karrasch <[email protected]>
dkarrasch
reviewed
Mar 11, 2021
dkarrasch
reviewed
Mar 11, 2021
Co-authored-by: Daniel Karrasch <[email protected]>
ElOceanografo
pushed a commit
to ElOceanografo/julia
that referenced
this pull request
May 4, 2021
antoine-levitt
pushed a commit
to antoine-levitt/julia
that referenced
this pull request
May 9, 2021
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
pobject wasn't even documented.