Skip to content

Commit 8f02b7f

Browse files
authored
doc: move solvers doc to src\solvers.md (#576)
1 parent 485fd4b commit 8f02b7f

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

docs/src/index.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -206,20 +206,6 @@ section of the standard library reference.
206206
| [`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. |
207207
| [`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 |
208208

209-
## [Sparse Linear Algebra](@id stdlib-sparse-linalg)
210-
211-
Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com). The following factorizations are available:
212-
213-
1. [`cholesky`](@ref SparseArrays.CHOLMOD.cholesky)
214-
2. [`ldlt`](@ref SparseArrays.CHOLMOD.ldlt)
215-
3. [`lu`](@ref SparseArrays.UMFPACK.lu)
216-
4. [`qr`](@ref SparseArrays.SPQR.qr)
217-
218-
| Type | Description |
219-
|:----------------------|:--------------------------------------------- |
220-
| `CHOLMOD.Factor` | Cholesky and LDLt factorizations |
221-
| `UMFPACK.UmfpackLU` | LU factorization |
222-
| `SPQR.QRSparse` | QR factorization |
223209

224210
```@meta
225211
DocTestSetup = nothing

docs/src/solvers.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,24 @@
44
DocTestSetup = :(using LinearAlgebra, SparseArrays)
55
```
66

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)
17+
18+
| Type | Description |
19+
|:----------------------|:--------------------------------------------- |
20+
| `CHOLMOD.Factor` | Cholesky and LDLt factorizations |
21+
| `UMFPACK.UmfpackLU` | LU factorization |
22+
| `SPQR.QRSparse` | QR factorization |
23+
24+
725
```@docs; canonical=false
826
SparseArrays.CHOLMOD.cholesky
927
SparseArrays.CHOLMOD.cholesky!

0 commit comments

Comments
 (0)