Documentation

Author: fverdugo

docs/examples.jl

@@ -145,7 +145,7 @@ IV = map(row_partition) do row_indices
     I,V
 end
 I,V = tuple_of_arrays(IV)
-b = old_pvector!(I,V,row_partition) |> fetch
+b = pvector(I,V,row_partition) |> fetch
 
 
 # Compute the system matrix
@@ -172,7 +172,7 @@ IJV = map(row_partition) do row_indices
 end
 I,J,V = tuple_of_arrays(IJV)
 col_partition = row_partition
-A = old_psparse!(I,J,V,row_partition,col_partition) |> fetch
+A = psparse(I,J,V,row_partition,col_partition) |> fetch
 
 # Generate an initial guess that fulfills
 # the boundary conditions.
@@ -188,4 +188,3 @@ norm(r)
 
 
 
-

src/p_sparse_matrix.jl

@@ -1014,9 +1014,6 @@ Crate an instance of [`PSparseMatrix`](@ref) by setting arbitrary entries
 from each of the underlying parts. It returns a task that produces the
 instance of [`PSparseMatrix`](@ref) allowing latency hiding while performing
 the communications needed in its setup.
-
-!!! warning
-    Improve me!
 """
 function psparse(f,I,J,V,rows,cols;
         split=true,
@@ -1097,8 +1094,7 @@ function psparse(f,I,J,V,rows,cols;
 end
 
 """
-!!! warning
-    Document me!
+    psparse!(C::PSparseMatrix,V,cache)
 """
 function psparse!(C,V,cache)
     (A,B,K,cacheB,cacheC,split,assembled) = cache
@@ -1122,8 +1118,7 @@ function assemble(A::PSparseMatrix;kwargs...)
 end
 
 """
-!!! warning
-    Document me!
+    assemble(A::PSparseMatrix[,rows];kwargs...)
 """
 function assemble(A::PSparseMatrix,rows;kwargs...)
     @boundscheck @assert matching_own_indices(axes(A,1),PRange(rows))
@@ -1132,8 +1127,7 @@ function assemble(A::PSparseMatrix,rows;kwargs...)
 end
 
 """
-!!! warning
-    Document me!
+    assemble!(B::PSparseMatrix,A::PSparseMatrix,cache)
 """
 function assemble!(B::PSparseMatrix,A::PSparseMatrix,cache)
     T = eltype(partition(A))
@@ -1385,8 +1379,7 @@ function psparse_assemble_impl!(B,A,::Type{<:AbstractSplitMatrix},cache)
 end
 
 """
-!!! warning
-    Document me!
+    consistent(A::PSparseMatrix,rows;kwargs...)
 """
 function consistent(A::PSparseMatrix,rows_co;kwargs...)
     @assert A.assembled
@@ -1395,8 +1388,7 @@ function consistent(A::PSparseMatrix,rows_co;kwargs...)
 end
 
 """
-!!! warning
-    Document me!
+    consistent!(B::PSparseMatrix,A::PSparseMatrix,cache)
 """
 function consistent!(B::PSparseMatrix,A::PSparseMatrix,cache)
     @assert A.assembled
@@ -1668,8 +1660,7 @@ function IterativeSolvers.zerox(A::PSparseMatrix,b::PVector)
 end
 
 """
-!!! warning
-    Document me!
+    repartition(A::PSparseMatrix,new_rows,new_cols;reuse=false)
 """
 function repartition(A::PSparseMatrix,new_rows,new_cols;reuse=Val(false))
     function prepare_triplets(A_own_own,A_own_ghost,A_rows,A_cols)
@@ -1703,8 +1694,7 @@ function repartition(A::PSparseMatrix,new_rows,new_cols;reuse=Val(false))
 end
 
 """
-!!! warning
-    Document me!
+    repartition!(B::PSparseMatrix,A::PSparseMatrix,cache)
 """
 function repartition!(B::PSparseMatrix,A::PSparseMatrix,cache)
     (V,cacheB) = cache
@@ -1723,8 +1713,7 @@ function repartition!(B::PSparseMatrix,A::PSparseMatrix,cache)
 end
 
 """
-!!! warning
-    Document me!
+    repartition(A::PSparseMatrix,b::PVector,new_rows,new_cols;reuse=false)
 """
 function repartition(A::PSparseMatrix,b::PVector,new_rows,new_cols;reuse=Val(false))
     # TODO this is just a reference implementation
@@ -1744,8 +1733,14 @@ function repartition(A::PSparseMatrix,b::PVector,new_rows,new_cols;reuse=Val(fal
 end
 
 """
-!!! warning
-    Document me!
+    repartition!(B,c,A,b,cache)
+
+- `B::PSparseMatrix`
+- `c::PVector`
+- `A::PSparseMatrix`
+- `b::PVector`
+- `cache`
+
 """
 function repartition!(B::PSparseMatrix,c::PVector,A::PSparseMatrix,b::PVector,cache)
     (cacheB,cachec) = cache
@@ -1759,8 +1754,7 @@ function repartition!(B::PSparseMatrix,c::PVector,A::PSparseMatrix,b::PVector,ca
 end
 
 """
-!!! warning
-    Document me!
+    psystem(I,J,V,I2,V2,rows,cols;kwargs...)
 """
 function psystem(I,J,V,I2,V2,rows,cols;
         assembled=false,
@@ -1809,8 +1803,7 @@ function psystem(I,J,V,I2,V2,rows,cols;
 end
 
 """
-!!! warning
-    Document me!
+    psystem!(A,b,V,V2,cache)
 """
 function psystem!(A,b,V,V2,cache)
     (cacheA,cacheb) = cache

src/p_vector.jl

@@ -562,7 +562,7 @@ function pvector(I,V,rows;kwargs...)
 end
 
 """
-    pvector([f,]I,V,index_partition;discover_rows=true) -> Task
+    pvector([f,]I,V,index_partition;kwargs...) -> Task
 
 Crate an instance of [`PVector`](@ref) by setting arbitrary entries
 from each of the underlying parts. It returns a task that produces the
@@ -618,8 +618,7 @@ function pvector(f,I,V,rows;
 end
 
 """
-!!! warning
-    Document me!
+    pvector!(B::PVector,V,cache)
 """
 function pvector!(B,V,cache)
     function update!(A,K,V)
@@ -935,8 +934,7 @@ function assemble(v::PVector;kwargs...)
 end
 
 """
-!!! warning
-    Document me!
+    assemble(v::PVector[,rows];reuse=false)
 """
 function assemble(v::PVector,rows;reuse=Val(false))
     @boundscheck @assert matching_own_indices(axes(v,1),PRange(rows))
@@ -959,8 +957,7 @@ function assemble(v::PVector,rows;reuse=Val(false))
 end
 
 """
-!!! warning
-    Document me!
+    assemble!(w::PVector,v::PVector,cache)
 """
 function assemble!(w::PVector,v::PVector,cache)
     # TODO this is just a reference implementation
@@ -977,8 +974,7 @@ function assemble!(w::PVector,v::PVector,cache)
 end
 
 """
-!!! warning
-    Document me!
+    consistent(v::PVector,rows;reuse=false)
 """
 function consistent(v::PVector,rows;reuse=Val(false))
     # TODO this is just a reference implementation
@@ -998,8 +994,7 @@ function consistent(v::PVector,rows;reuse=Val(false))
 end
 
 """
-!!! warning
-    Document me!
+    consistent!(w::PVector,v::PVector,cache)
 """
 function consistent!(w::PVector,v::PVector,cache)
     w .= v
@@ -1024,8 +1019,7 @@ function repartition_cache(v::PVector,new_partition)
 end
 
 """
-!!! warning
-    Document me!
+    repartition(v::PVector,new_partition;reuse=false)
 """
 function repartition(v::PVector,new_partition;reuse=Val(false))
     w = similar(v,PRange(new_partition))
@@ -1047,8 +1041,7 @@ function repartition!(w::PVector,v::PVector;kwargs...)
 end
 
 """
-!!! warning
-    Document me!
+    repartition!(w::PVector,v::PVector[,cache];reversed=false)
 """
 function repartition!(w::PVector,v::PVector,cache;reversed=false)
     new_partition = partition(axes(w,1))