Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adapt to Documenter v1 #444

Merged
merged 11 commits into from
Oct 10, 2023
Merged

Adapt to Documenter v1 #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
466676f
Adapt to Documenter v1
dkarrasch Sep 26, 2023
07019d3
fix (some) docs issues
dkarrasch Sep 26, 2023
4346177
fix more docs issues
dkarrasch Sep 26, 2023
f02d008
fix reference to random numbers
dkarrasch Sep 26, 2023
1497260
warnonly
dkarrasch Oct 6, 2023
87d02ff
revert docs changes
dkarrasch Oct 6, 2023
68a4bdd
fix cholmod docstrings
dkarrasch Oct 6, 2023
c3b786b
revert spqr changes
dkarrasch Oct 6, 2023
de902a0
revert umfpack changes
dkarrasch Oct 6, 2023
200f0e6
revert sparsematrix changes
dkarrasch Oct 6, 2023
d826b64
Merge branch 'main' into dk/documenter@v1
dkarrasch Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

[compat]
Documenter = "1"
3 changes: 1 addition & 2 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ makedocs(
"SparseArrays" => "index.md",
"Sparse Linear Algebra" => "solvers.md",
];
# strict = true,
strict = Symbol[:doctest],
warnonly = [:missing_docs, :cross_references],
)

deploydocs(repo = "github.com/JuliaSparse/SparseArrays.jl.git")
5 changes: 4 additions & 1 deletion docs/src/solvers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ Sparse matrix solvers call functions from [SuiteSparse](http://suitesparse.com).

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 [`Linear Algebra`](https://docs.julialang.org/en/v1/stdlib/LinearAlgebra/) section of the manual:
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)
Expand Down
7 changes: 4 additions & 3 deletions src/solvers/cholmod.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ using LinearAlgebra
using LinearAlgebra: RealHermSymComplexHerm, AdjOrTrans
import LinearAlgebra: (\), AdjointFactorization,
cholesky, cholesky!, det, diag, ishermitian, isposdef,
issuccess, issymmetric, ldlt, ldlt!, logdet, lowrankdowndate!
issuccess, issymmetric, ldlt, ldlt!, logdet,
lowrankdowndate, lowrankdowndate!, lowrankupdate, lowrankupdate!

using SparseArrays
using SparseArrays: getcolptr, AbstractSparseVecOrMat
Expand Down Expand Up @@ -1548,7 +1549,7 @@ factor will be `L*L' == P*A*P' + C'*C`

`update`: `Cint(1)` for `A + CC'`, `Cint(0)` for `A - CC'`
"""
lowrankdowndate!
lowrankupdowndate!

#Helper functions for rank updates
lowrank_reorder(V::AbstractArray,p) = Sparse(sparse(V[p,:]))
Expand Down Expand Up @@ -1597,7 +1598,7 @@ lowrankupdate(F::Factor{Tv}, V::AbstractArray{Tv}) where {Tv<:VTypes} =
lowrankupdate!(copy(F), V)

"""
lowrankupdate(F::CHOLMOD.Factor, C::AbstractArray) -> FF::CHOLMOD.Factor
lowrankdowndate(F::CHOLMOD.Factor, C::AbstractArray) -> FF::CHOLMOD.Factor

Get an `LDLt` Factorization of `A + C*C'` given an `LDLt` or `LLt` factorization `F` of `A`.

Expand Down
Loading