From 9bade12962107e254bfc6fda95950a32a4acd5c2 Mon Sep 17 00:00:00 2001 From: Chengyu HAN Date: Sat, 26 Oct 2024 15:26:49 +0800 Subject: [PATCH] doc: move solvers doc to `src\solvers.md` --- docs/src/index.md | 14 -------------- docs/src/solvers.md | 18 ++++++++++++++++++ 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index 69b5a87a..225d5a0b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -206,20 +206,6 @@ 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](@id stdlib-sparse-linalg) - -Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com). The following factorizations are available: - -1. [`cholesky`](@ref SparseArrays.CHOLMOD.cholesky) -2. [`ldlt`](@ref SparseArrays.CHOLMOD.ldlt) -3. [`lu`](@ref SparseArrays.UMFPACK.lu) -4. [`qr`](@ref SparseArrays.SPQR.qr) - -| Type | Description | -|:----------------------|:--------------------------------------------- | -| `CHOLMOD.Factor` | Cholesky and LDLt factorizations | -| `UMFPACK.UmfpackLU` | LU factorization | -| `SPQR.QRSparse` | QR factorization | ```@meta DocTestSetup = nothing diff --git a/docs/src/solvers.md b/docs/src/solvers.md index 1c7c630d..c2624b81 100644 --- a/docs/src/solvers.md +++ b/docs/src/solvers.md @@ -4,6 +4,24 @@ DocTestSetup = :(using LinearAlgebra, SparseArrays) ``` +## [Sparse Linear Algebra](@id stdlib-sparse-linalg) + +Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com). + +The following factorizations are available: + +1. [`cholesky`](@ref SparseArrays.CHOLMOD.cholesky) +2. [`ldlt`](@ref SparseArrays.CHOLMOD.ldlt) +3. [`lu`](@ref SparseArrays.UMFPACK.lu) +4. [`qr`](@ref SparseArrays.SPQR.qr) + +| Type | Description | +|:----------------------|:--------------------------------------------- | +| `CHOLMOD.Factor` | Cholesky and LDLt factorizations | +| `UMFPACK.UmfpackLU` | LU factorization | +| `SPQR.QRSparse` | QR factorization | + + ```@docs; canonical=false SparseArrays.CHOLMOD.cholesky SparseArrays.CHOLMOD.cholesky!