Skip to content

Commit 2c94153

Browse files
committed
more docs
1 parent 729368e commit 2c94153

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

src/dense.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1738,6 +1738,12 @@ algorithm instead uses pivoted QR factorization ([`qr`](@ref)). To use an
17381738
SVD-based algorithm, it is better to employ the SVD directly via `svd(M; rtol, atol) \\ b`,
17391739
or to pass `rtol` and `atol` parameters via [`ldiv!`](@ref) with `svd(M)`.
17401740
1741+
One can also pass `M = svd(A)` as the argument to `pinv` in order to re-use
1742+
an existing [`SVD`](@ref) object.
1743+
1744+
!!! compat "Julia 1.13"
1745+
Passing an `SVD` object to `pinv` requires Julia 1.13 or later.
1746+
17411747
For more information, see [^pr1387], [^B96], [^S84], [^KY88].
17421748
17431749
# Examples

src/svd.jl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,9 @@ Similar to the [`pinv`](@ref) function, the solution can be regularized by trunc
288288
dropping any singular values less than `max(atol, rtol*σ₁)` where `σ₁` is the largest singular value.
289289
The default relative tolerance is `n*ϵ`, where `n` is the size of the smallest dimension of `M`, and
290290
`ϵ` is the [`eps`](@ref) of the element type of `M`.
291+
292+
!!! compat "Julia 1.13"
293+
The `atol` and `rtol` arguments require Julia 1.13 or later.
291294
"""
292295
function ldiv!(F::SVD{T}, B::AbstractVecOrMat; atol::Real=0, rtol::Real = (eps(real(float(oneunit(T))))*min(size(F)...))*iszero(atol)) where T
293296
m, n = size(F)

0 commit comments

Comments
 (0)