summaryrefslogtreecommitdiff
path: root/research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/SuiteSparse/docs/src/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/SuiteSparse/docs/src/index.md')
-rw-r--r--research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/SuiteSparse/docs/src/index.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/SuiteSparse/docs/src/index.md b/research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/SuiteSparse/docs/src/index.md
new file mode 100644
index 0000000..e8654ca
--- /dev/null
+++ b/research/flossing/external/julia-1.6.7/share/julia/stdlib/v1.6/SuiteSparse/docs/src/index.md
@@ -0,0 +1,34 @@
+# Sparse Linear Algebra
+
+```@meta
+DocTestSetup = :(using LinearAlgebra, SparseArrays, SuiteSparse)
+```
+
+Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com). The following factorizations are available:
+
+| Type | Description |
+|:--------------------------------- |:--------------------------------------------- |
+| `SuiteSparse.CHOLMOD.Factor` | Cholesky factorization |
+| `SuiteSparse.UMFPACK.UmfpackLU` | LU factorization |
+| `SuiteSparse.SPQR.QRSparse` | QR factorization |
+
+Other solvers such as [Pardiso.jl](https://github.com/JuliaSparse/Pardiso.jl/) are 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 the [`Linear Algebra`](@ref man-linalg) section of the manual:
+1. [`cholesky`](@ref)
+2. [`ldlt`](@ref)
+3. [`lu`](@ref)
+4. [`qr`](@ref)
+
+```@docs
+SuiteSparse.CHOLMOD.lowrankupdate
+SuiteSparse.CHOLMOD.lowrankupdate!
+SuiteSparse.CHOLMOD.lowrankdowndate
+SuiteSparse.CHOLMOD.lowrankdowndate!
+SuiteSparse.CHOLMOD.lowrankupdowndate!
+```
+
+
+```@meta
+DocTestSetup = nothing
+```