From 91b0aa56a64136c920799533ab6a743d008118bf Mon Sep 17 00:00:00 2001 From: CyHan Date: Sat, 26 Oct 2024 22:29:08 +0800 Subject: [PATCH] doc: move solvers doc to `src\solvers.md` (#576) --- docs/src/index.md | 5 +++++ docs/src/solvers.md | 23 +++++++++++++++-------- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index 5ddae840..ceca6fb9 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -202,6 +202,11 @@ 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 | + +```@meta +DocTestSetup = nothing +``` + # [SparseArrays API](@id stdlib-sparse-arrays) ```@docs diff --git a/docs/src/solvers.md b/docs/src/solvers.md index e633be9d..4763ffcb 100644 --- a/docs/src/solvers.md +++ b/docs/src/solvers.md @@ -4,7 +4,16 @@ DocTestSetup = :(using LinearAlgebra, SparseArrays) ``` -Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com). The following factorizations are available: +## [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 | |:--------------------------------- |:--------------------------------------------- | @@ -12,18 +21,16 @@ Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com). | `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. +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 +```@docs; canonical=false SparseArrays.CHOLMOD.cholesky SparseArrays.CHOLMOD.cholesky! SparseArrays.CHOLMOD.ldlt