Documentation fixes

Author: j-fu

docs/Project.toml

@@ -5,7 +5,3 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
 ExtendableSparse = "95c220a8-a1cf-11e9-0c77-dbfce5f500b3"
 
-[compat]
-DocStringExtensions = "^0.8"
-DocumenterTools = "^0.1"
-Documenter = "^0.25"

docs/make.jl

@@ -4,14 +4,15 @@ using Documenter, ExtendableSparse
 makedocs(sitename="ExtendableSparse.jl",
          modules = [ExtendableSparse],
          doctest = true,
-         clean = true,
+         clean = false,
          authors = "J. Fuhrmann",
          repo="https://github.com/j-fu/ExtendableSparse.jl",
          pages=[
              "Home"=>"index.md",
              "example.md",
+             "extsparse.md",
+             "iter.md",
              "changes.md",
-             "api.md"
          ])
 
 deploydocs(repo = "github.com/j-fu/ExtendableSparse.jl.git")

docs/src/api.md

@@ -1,4 +1,12 @@
 # Changes
+
+## v0.3.7, March 20, 2021
+- Added parallel jacobi preconditioner (thanks, @jkr)
+- Fixes ldiv
+- Added simple iterative solver
+- Documentation update
+- Tests for precondioners, fdrand
+
 ## v0.3.0, April 10, 2020
 - Don't create new entry if the value to be assigned is zero, making things consistent with SparseMatrixCSC and ForwardDiff 
   as suggested by @MaximilianJHuber

docs/src/changes.md

@@ -73,6 +73,7 @@ using BenchmarkTools   # hide
 A=fdrand(30,30,30, matrixtype=SparseMatrixCSC);
 @benchmark fdrand!(A,30,30,30, update=(A,v,i,j)-> A[i,j]+=v);
 ```
+
 ```@example
 using ExtendableSparse # hide
 using SparseArrays     # hide
@@ -90,6 +91,7 @@ using BenchmarkTools   # hide
 A=fdrand(30,30,30, matrixtype=ExtendableSparseMatrix);
 @benchmark fdrand!(A,30,30,30, update=(A,v,i,j)-> A[i,j]+=v);
 ```
+
 ```@example
 using ExtendableSparse # hide
 using BenchmarkTools   # hide

docs/src/example.md

@@ -0,0 +1,7 @@
+# Sparse matrix handling
+
+```@autodocs
+Modules = [ExtendableSparse]
+Pages = ["sparsematrixlnk.jl","sparsematrixcsc.jl","extendable.jl", "sprand.jl"]
+```
+

docs/src/extsparse.md

@@ -0,0 +1,5 @@
+# Preconditioners
+```@autodocs
+Modules = [ExtendableSparse]
+Pages = ["preconditioners.jl", "ilu0.jl", "jacobi.jl", "parallel_jacobi.jl","simple_iteration.jl"]
+```

docs/src/iter.md

@@ -6,7 +6,7 @@ using LinearAlgebra
 include("sparsematrixcsc.jl")
 include("sparsematrixlnk.jl")
 include("extendable.jl")
-export SparseMatrixLNK,ExtendableSparseMatrix,flush!,nnz, updateindex, colptrs
+export SparseMatrixLNK,ExtendableSparseMatrix,flush!,nnz, updateindex!, colptrs
 
 include("preconditioners.jl")
 export JacobiPreconditioner, ILU0Preconditioner, ParallelJacobiPreconditioner

src/ExtendableSparse.jl

@@ -1,11 +1,20 @@
+"""
+$(TYPEDEF)
+
+ILU(0) Preconditioner
+"""
 mutable struct ILU0Preconditioner{Tv, Ti} <: AbstractExtendablePreconditioner{Tv,Ti}
     extmatrix::ExtendableSparseMatrix{Tv,Ti}
     xdiag::Array{Tv,1}
     idiag::Array{Ti,1}
     pattern_timestamp::Float64
 end
 
+"""
+$(SIGNATURES)
 
+Constructor for ILU(0) preconditioner
+"""
 function ILU0Preconditioner(extmatrix::ExtendableSparseMatrix{Tv,Ti}) where {Tv,Ti}
     @assert size(extmatrix,1)==size(extmatrix,2)
     flush!(extmatrix)
@@ -16,9 +25,19 @@ function ILU0Preconditioner(extmatrix::ExtendableSparseMatrix{Tv,Ti}) where {Tv,
     update!(precon)
 end
 
+"""
+$(SIGNATURES)
+
+Constructor for ILU(0) preconditioner
+"""
 ILU0Preconditioner(cscmatrix::SparseMatrixCSC{Tv,Ti}) where {Tv,Ti}=ILU0Preconditioner(ExtendableSparseMatrix(cscmatrix))
 
 
+"""
+$(SIGNATURES)
+
+Update ILU(0) preconditioner
+"""
 function update!(precon::ILU0Preconditioner{Tv,Ti}) where {Tv,Ti}
     cscmatrix=precon.extmatrix.cscmatrix
     colptr=cscmatrix.colptr
@@ -59,6 +78,11 @@ function update!(precon::ILU0Preconditioner{Tv,Ti}) where {Tv,Ti}
 end
 
 
+"""
+$(SIGNATURES)
+
+Solve preconditioning system for ILU(0)
+"""
 function  LinearAlgebra.ldiv!(u::AbstractArray{T,1}, precon::ILU0Preconditioner, v::AbstractArray{T,1}) where T
     cscmatrix=precon.extmatrix.cscmatrix
     colptr=cscmatrix.colptr
@@ -85,6 +109,11 @@ function  LinearAlgebra.ldiv!(u::AbstractArray{T,1}, precon::ILU0Preconditioner,
     end
 end
 
+"""
+$(SIGNATURES)
+
+Inplace solve of preconditioning system for ILU(0)
+"""
 function LinearAlgebra.ldiv!(precon::ILU0Preconditioner, v::AbstractArray{T,1} where T)
     ldiv!(v, precon, v)
 end

src/ilu0.jl

@@ -1,8 +1,18 @@
+"""
+$(TYPEDEF)
+
+Jacobi preconditoner
+"""
 struct JacobiPreconditioner{Tv, Ti} <: AbstractExtendablePreconditioner{Tv,Ti}
     extmatrix::ExtendableSparseMatrix{Tv,Ti}
     invdiag::Array{Tv,1}
 end
 
+"""
+$(SIGNATURES)
+
+Update Jacobi preconditoner
+"""
 function update!(precon::JacobiPreconditioner)
     cscmatrix=precon.extmatrix.cscmatrix
     invdiag=precon.invdiag
@@ -13,6 +23,11 @@ function update!(precon::JacobiPreconditioner)
     precon
 end
 
+"""
+$(SIGNATURES)
+
+Construct Jacobi preconditoner
+"""
 function JacobiPreconditioner(extmatrix::ExtendableSparseMatrix{Tv,Ti}) where {Tv,Ti}
     @assert size(extmatrix,1)==size(extmatrix,2)
     flush!(extmatrix)
@@ -21,9 +36,19 @@ function JacobiPreconditioner(extmatrix::ExtendableSparseMatrix{Tv,Ti}) where {T
     update!(precon)
 end
 
+"""
+$(SIGNATURES)
+
+Construct Jacobi preconditoner
+"""
 JacobiPreconditioner(cscmatrix::SparseMatrixCSC{Tv,Ti}) where {Tv,Ti}=JacobiPreconditioner(ExtendableSparseMatrix(cscmatrix))
 
 
+"""
+$(SIGNATURES)
+
+Solve  Jacobi preconditioning system
+"""
 function  LinearAlgebra.ldiv!(u::AbstractArray{T,1} where T, precon::JacobiPreconditioner, v::AbstractArray{T,1} where T)
     invdiag=precon.invdiag
     n=length(invdiag)
@@ -32,6 +57,11 @@ function  LinearAlgebra.ldiv!(u::AbstractArray{T,1} where T, precon::JacobiPreco
     end
 end
 
+"""
+$(SIGNATURES)
+
+Inplace solve  Jacobi preconditioning system
+"""
 function LinearAlgebra.ldiv!(precon::JacobiPreconditioner, v::AbstractArray{T,1} where T)
     ldiv!(v, precon, v)
 end