Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify svd documentation #303

Closed
eschnett opened this issue Jan 25, 2016 · 1 comment · Fixed by JuliaLang/julia#15103
Closed

Clarify svd documentation #303

eschnett opened this issue Jan 25, 2016 · 1 comment · Fixed by JuliaLang/julia#15103
Labels
docs This change adds or pertains to documentation

Comments

@eschnett
Copy link
Contributor

The svd(A, B) documentation (and similarly the svdfact documentation) currently say

  svd(A, B) -> U, V, Q, D1, D2, R0

  Wrapper around svdfact extracting all parts the factorization to a tuple.
  Direct use of svdfact is therefore generally more efficient. The function
  returns the generalized SVD of A and B, returning U, V, Q, D1, D2, and R0
  such that A = U*D1*R0*Q' and B = V*D2*R0*Q'.

I'm familiar with SVDs in the mathematical sense, but not with Julia's implementation. From convention, I know what U and V are, but I don't know the other symbols (Q, D1, D2, and R0). I assume that at least one of these is a vector (i.e. a diagonal matrix). I also assume that some additional conditions hold between these quantities.

If you're familiar with SVDs, could you update the documentation to have more detail? For example, a description in the style of svd(A) would already be sufficient for me.

@kshyatt kshyatt added docs This change adds or pertains to documentation linear algebra labels Jan 25, 2016
@jiahao
Copy link
Member

jiahao commented Jan 27, 2016

The notation is for the generalized SVD as provided by LAPACK.

jiahao referenced this issue in JuliaLang/julia Feb 16, 2016
jiahao referenced this issue in JuliaLang/julia Feb 16, 2016
@KristofferC KristofferC transferred this issue from JuliaLang/julia Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants