Skip to content

Commit

Permalink
update docstring for qr
Browse files Browse the repository at this point in the history
Explain in docstring how to obtain both the thin and full factors.  This is related to issue JuliaLang#27397.
  • Loading branch information
StephenVavasis authored Aug 4, 2018
1 parent dd248bf commit 4fe43cf
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion stdlib/LinearAlgebra/src/qr.jl
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,9 @@ solution and if the solution is not unique, the one with smallest norm is return
Multiplication with respect to either full/square or non-full/square `Q` is allowed, i.e. both `F.Q*F.R`
and `F.Q*A` are supported. A `Q` matrix can be converted into a regular matrix with
[`Matrix`](@ref).
[`Matrix`](@ref). This operation returns the "thin" Q factor, i.e., if `A` is m-by-n, then
`Matrix(F.Q)` yields an m-by-n matrix with orthogonal columns. To retrieve the "full" Q factor, an
m-by-m orthogonal matrix, use `F.Q*Matrix(I,m,m)`.
# Examples
```jldoctest
Expand Down

0 comments on commit 4fe43cf

Please sign in to comment.