Skip to content

Commit

Permalink
update docstring for qr (#28446)
Browse files Browse the repository at this point in the history
* update docstring for qr

Explain in docstring how to obtain both the thin and full factors.  This is related to issue #27397.

* further improvement/clarification
  • Loading branch information
StephenVavasis authored and andreasnoack committed Aug 7, 2018
1 parent cc29668 commit 06dad95
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion stdlib/LinearAlgebra/src/qr.jl
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,10 @@ 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`×`n` with `m>=n`, then
`Matrix(F.Q)` yields an `m`×`n` matrix with orthonormal columns. To retrieve the "full" Q factor, an
`m`×`m` orthogonal matrix, use `F.Q*Matrix(I,m,m)`. If `m<=n`, then `Matrix(F.Q)` yields an `m`×`m`
orthogonal matrix.
# Examples
```jldoctest
Expand Down

0 comments on commit 06dad95

Please sign in to comment.