Skip to content

Commit 242de06

Browse files
authored
Merge pull request #19691 from JuliaLang/ksh/docattack
More cross refs and doctests for linalg
2 parents d7b6ac3 + f81d64c commit 242de06

File tree

11 files changed

+360
-136
lines changed

11 files changed

+360
-136
lines changed

base/docs/helpdb/Base.jl

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2616,23 +2616,6 @@ algorithms. See [`muladd`](@ref).
26162616
"""
26172617
fma
26182618

2619-
"""
2620-
2621-
eigvals(A,[irange,][vl,][vu]) -> values
2622-
2623-
Returns the eigenvalues of `A`. If `A` is `Symmetric`, `Hermitian` or `SymTridiagonal`,
2624-
it is possible to calculate only a subset of the eigenvalues by specifying either a
2625-
`UnitRange` `irange` covering indices of the sorted eigenvalues, or a pair `vl` and `vu`
2626-
for the lower and upper boundaries of the eigenvalues.
2627-
2628-
For general non-symmetric matrices it is possible to specify how the matrix is balanced
2629-
before the eigenvector calculation. The option `permute=true` permutes the matrix to
2630-
become closer to upper triangular, and `scale=true` scales the matrix by its diagonal
2631-
elements to make rows and columns moreequal in norm. The default is `true` for both
2632-
options.
2633-
"""
2634-
eigvals
2635-
26362619
"""
26372620
copy!(dest, src)
26382621

base/linalg/arnoldi.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -349,9 +349,9 @@ X = sprand(10, 5, 0.2)
349349
svds(X, nsv = 2)
350350
```
351351
352-
**Implementation note**
352+
!!! note "Implementation"
353353
354-
`svds(A)` is formally equivalent to calling `eigs` to perform implicitly restarted
354+
`svds(A)` is formally equivalent to calling [`eigs`](@ref) to perform implicitly restarted
355355
Lanczos tridiagonalization on the Hermitian matrix
356356
``\\begin{pmatrix} 0 & A^\\prime \\\\ A & 0 \\end{pmatrix}``, whose eigenvalues are
357357
plus and minus the singular values of ``A``.

0 commit comments

Comments
 (0)