Skip to content

Commit 91b0aa5

Browse files
inkydragondkarrasch
authored andcommitted
doc: move solvers doc to src\solvers.md (#576)
1 parent 5d3724a commit 91b0aa5

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

docs/src/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,11 @@ section of the standard library reference.
202202
| [`sprandn(m,n,d)`](@ref) | [`randn(m,n)`](@ref) | Creates a *m*-by-*n* random matrix (of density *d*) with iid non-zero elements distributed according to the standard normal (Gaussian) distribution. |
203203
| [`sprandn(rng,m,n,d)`](@ref) | [`randn(rng,m,n)`](@ref) | Creates a *m*-by-*n* random matrix (of density *d*) with iid non-zero elements generated with the `rng` random number generator |
204204

205+
206+
```@meta
207+
DocTestSetup = nothing
208+
```
209+
205210
# [SparseArrays API](@id stdlib-sparse-arrays)
206211

207212
```@docs

docs/src/solvers.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,33 @@
44
DocTestSetup = :(using LinearAlgebra, SparseArrays)
55
```
66

7-
Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com). The following factorizations are available:
7+
## [Sparse Linear Algebra](@id stdlib-sparse-linalg)
8+
9+
Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com).
10+
11+
The following factorizations are available:
12+
13+
1. [`cholesky`](@ref SparseArrays.CHOLMOD.cholesky)
14+
2. [`ldlt`](@ref SparseArrays.CHOLMOD.ldlt)
15+
3. [`lu`](@ref SparseArrays.UMFPACK.lu)
16+
4. [`qr`](@ref SparseArrays.SPQR.qr)
817

918
| Type | Description |
1019
|:--------------------------------- |:--------------------------------------------- |
1120
| `CHOLMOD.Factor` | Cholesky factorization |
1221
| `UMFPACK.UmfpackLU` | LU factorization |
1322
| `SPQR.QRSparse` | QR factorization |
1423

15-
Other solvers such as [Pardiso.jl](https://github.com/JuliaSparse/Pardiso.jl/) are available as external packages. [Arpack.jl](https://julialinearalgebra.github.io/Arpack.jl/stable/) provides `eigs` and `svds` for iterative solution of eigensystems and singular value decompositions.
24+
Other solvers such as [Pardiso.jl](https://github.com/JuliaSparse/Pardiso.jl/) are available
25+
as external packages. [Arpack.jl](https://julialinearalgebra.github.io/Arpack.jl/stable/)
26+
provides `eigs` and `svds` for iterative solution of eigensystems and singular value
27+
decompositions.
1628

1729
These factorizations are described in more detail in the
1830
[`Linear Algebra`](https://docs.julialang.org/en/v1/stdlib/LinearAlgebra/)
1931
section of the manual:
2032

21-
1. [`cholesky`](@ref SparseArrays.CHOLMOD.cholesky)
22-
2. [`ldlt`](@ref SparseArrays.CHOLMOD.ldlt)
23-
3. [`lu`](@ref SparseArrays.UMFPACK.lu)
24-
4. [`qr`](@ref SparseArrays.SPQR.qr)
25-
26-
```@docs
33+
```@docs; canonical=false
2734
SparseArrays.CHOLMOD.cholesky
2835
SparseArrays.CHOLMOD.cholesky!
2936
SparseArrays.CHOLMOD.ldlt

0 commit comments

Comments
 (0)