Merge Sparse Linear Algebra docs into SparseArrays so that it shows i…

…n the Julia manual
JuliaSparse · Aug 3, 2024 · 07f92f0 · 07f92f0
1 parent 86e215a
commit 07f92f0
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 45 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -8,7 +8,6 @@ makedocs(
     sitename = "SparseArrays",
     pages = Any[
         "SparseArrays" => "index.md",
-        "Sparse Linear Algebra" => "solvers.md",
         ];
     warnonly = [:missing_docs, :cross_references],
     )

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -206,6 +206,47 @@ section of the standard library reference.
 | [`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.                  |
 | [`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                                   |
 
+## Sparse Linear Algebra
+
+Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com). The following factorizations are available:
+
+| Type                              | Description                                   |
+|:--------------------------------- |:--------------------------------------------- |
+| `CHOLMOD.Factor`      | Cholesky factorization                        |
+| `UMFPACK.UmfpackLU`   | LU factorization                              |
+| `SPQR.QRSparse`       | QR factorization                              |
+
+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.
+
+These factorizations are described in more detail in the
+[`Linear Algebra`](https://docs.julialang.org/en/v1/stdlib/LinearAlgebra/)
+section of the manual:
+
+1. [`cholesky`](@ref SparseArrays.CHOLMOD.cholesky)
+2. [`ldlt`](@ref SparseArrays.CHOLMOD.ldlt)
+3. [`lu`](@ref SparseArrays.UMFPACK.lu)
+4. [`qr`](@ref SparseArrays.SPQR.qr)
+
+```@docs
+SparseArrays.CHOLMOD.cholesky
+SparseArrays.CHOLMOD.cholesky!
+SparseArrays.CHOLMOD.ldlt
+SparseArrays.SPQR.qr
+SparseArrays.UMFPACK.lu
+```
+
+```@docs
+SparseArrays.CHOLMOD.lowrankupdate
+SparseArrays.CHOLMOD.lowrankupdate!
+SparseArrays.CHOLMOD.lowrankdowndate
+SparseArrays.CHOLMOD.lowrankdowndate!
+SparseArrays.CHOLMOD.lowrankupdowndate!
+```
+
+```@meta
+DocTestSetup = nothing
+```
+
 # [SparseArrays API](@id stdlib-sparse-arrays)
 
 ```@docs

diff --git a/docs/src/solvers.md b/docs/src/solvers.md