document order of svdvals #22148
Merged
document order of svdvals #22148
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
fredrikekre
commented
May 30, 2017
| @@ -15,10 +15,6 @@ SVD(U::AbstractArray{T}, S::Vector{Tr}, Vt::AbstractArray{T}) where {T,Tr} = SVD | |||
|
|
|||
| `svdfact!` is the same as [`svdfact`](@ref), but saves space by | |||
| overwriting the input `A`, instead of creating a copy. | |||
|
|
|||
| If `thin=true` (default), a thin SVD is returned. For a ``M \\times N`` matrix | |||
There was a problem hiding this comment.
I removed this, this is consistent with all the other ! functions here, they simply refer to the non ! function.
kshyatt
added
docs
kshyatt
approved these changes
May 30, 2017
base/linalg/svd.jl
Outdated
| @@ -74,7 +71,7 @@ svdfact(x::Integer; thin::Bool=true) = svdfact(float(x), thin=thin) | |||
| svd(A, thin::Bool=true) -> U, S, V | |||
|
|
|||
| Computes the SVD of `A`, returning `U`, vector `S`, and `V` such that | |||
| `A == U*diagm(S)*V'`. | |||
| `A == U*diagm(S)*V'`. The singular values in `S` is sorted in descending order. | |||
tkelman
pushed a commit
that referenced
this pull request
Jun 3, 2017
(cherry picked from commit b5ac087)
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.
fix JuliaLang/LinearAlgebra.jl#368
ref: http://www.netlib.org/lapack/explore-html/d1/d7e/group__double_g_esing_ga76f797b6a9e278ad7b21aae2b4a55d76.html#ga76f797b6a9e278ad7b21aae2b4a55d76