fix some docstrings, AMGCLWrap dependency

Author: j-fu

Project.toml

@@ -31,7 +31,7 @@ ExtendableSparseIncompleteLUExt = "IncompleteLU"
 ExtendableSparsePardisoExt = "Pardiso"
 
 [compat]
-AMGCLWrap = "0.3.1,0.4"
+AMGCLWrap = "0.4"
 AlgebraicMultigrid = "0.4,0.5,0.6"
 DocStringExtensions = "0.8, 0.9"
 ILUZero = "0.2"

docs/src/internal.md

@@ -13,6 +13,17 @@ Pages = ["sparsematrixlnk.jl"]
 Modules = [ExtendableSparse]
 Pages = ["sparsematrixcsc.jl"]
 ```
+## New API 
+Under development - aimed at multithreading
+```@autodocs
+Modules = [ExtendableSparse]
+Pages = ["abstractsparsematrixextension.jl",
+    "abstractextendablesparsematrixcsc.jl",
+    "sparsematrixdilnkc.jl",
+    "genericextendablesparsematrixcsc.jl",
+    "genericmtextendablesparsematrixcsc.jl"]
+```
+
 
 ## Misc methods
 

src/matrix/abstractsparsematrixextension.jl

@@ -5,22 +5,13 @@ Abstract type for sparse matrix extension.
 
 Subtypes T_ext must implement:
 
-Constructor T_ext(m,n)
-SparseArrays.nnz(ext::T_ext)
-Base.size(ext::T_ext)
-
-
-Base.sum(extmatrices::Vector{T_ext}, csx)
-  - Add csx matrix and extension matrices (one per partition) and return csx matrix
-
-rawupdateindex!(ext::Text, op, v, i, j) where {Tv, Ti}
-  - Set ext[i,j]+=v, possibly insert entry into matrix.
-
-
-Optional:
-
-Base.+(ext::T_ext, csx)
-  - Add extension matrix and csc/csr matrix, return csx matrix
+- Constructor `T_ext(m,n)`
+- `SparseArrays.nnz(ext::T_ext)`
+- `Base.size(ext::T_ext)`
+- `Base.sum(extmatrices::Vector{T_ext}, csx)`:  add csr or csc matrix and extension matrices (one per partition) and return csx matrix
+- `Base.+(ext::T_ext, csx)` (optional)  - Add extension matrix and csc/csr matrix, return csx matrix
+- `rawupdateindex!(ext::Text, op, v, i, j, tid) where {Tv, Ti}`: Set `ext[i,j]op=v`, possibly insert new entry into matrix. `tid` is a
+task or partition id
 
 """
 abstract type AbstractSparseMatrixExtension{Tv, Ti} <: AbstractSparseMatrix{Tv,Ti} end

src/matrix/sparsematrixdilnkc.jl

@@ -103,6 +103,11 @@ function SparseMatrixDILNKC(csc::SparseArrays.SparseMatrixCSC{Tv, Ti}) where {Tv
     lnk
 end
 
+"""
+$(SIGNATURES)
+    
+Find index in matrix.
+"""
 function findindex(lnk::SparseMatrixDILNKC, i, j)
     if !((1 <= i <= lnk.m) & (1 <= j <= lnk.n))
         throw(BoundsError(lnk, (i, j)))
@@ -137,6 +142,11 @@ function Base.getindex(lnk::SparseMatrixDILNKC{Tv, Ti}, i, j) where {Tv, Ti}
     end
 end
 
+"""
+    $(SIGNATURES)
+
+Add entry.
+"""
 function addentry!(lnk::SparseMatrixDILNKC, i, j, k, k0)
     # increase number of entries
     lnk.nentries += 1