Merge pull request #2 from gridap/add/SymSparseMatrixCSR

Add/sym sparse matrix csr

Author: victorsndvg

Project.toml

@@ -1,7 +1,7 @@
 name = "SparseMatricesCSR"
 uuid = "a0a7dd2c-ebf4-11e9-1f05-cf50bc540ca1"
 authors = ["Víctor Sande <[email protected]>"]
-version = "0.1.0"
+version = "0.2.0"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

README.md

@@ -4,3 +4,32 @@
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gridap.github.io/SparseMatricesCSR.jl/dev)
 [![Build Status](https://travis-ci.com/gridap/SparseMatricesCSR.jl.svg?branch=master)](https://travis-ci.com/gridap/SparseMatricesCSR.jl)
 [![Codecov](https://codecov.io/gh/gridap/SparseMatricesCSR.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/gridap/SparseMatricesCSR.jl)
+
+Compressed Sparse Row (CSR) sparse matrix implementations.
+
+It includes `SparseMatrixCSR` and `SymSparseMatrixCSR` wrappers.
+
+CSR wrappers relies on `SparseMatrixCSC` native Julia type.
+
+## Basic Usage
+
+```julia
+julia> push_coo!(SymSparseMatrixCSR,I,J,V,i1,j1,v1)
+julia> ...
+julia> push_coo!(SymSparseMatrixCSR,I,J,V,in,jn,vn)
+julia> finalize_coo!(SparseMatrixCSR,I,J,V,m,n)
+julia> CSR= sparsecsr(I,J,V,m,n)
+
+```
+
+## Installation
+
+**SparseMatricesCSR** itself is installed when you add and use it into another project.
+
+To include into your project from Julia REPL, use the following commands:
+
+```
+pkg> add SparseMatricesCSR
+julia> using SparseMatricesCSR
+```
+

src/SparseMatricesCSR.jl

@@ -8,7 +8,7 @@ import SparseArrays: nnz, getnzval, nzvalview, nonzeros, nzrange, findnz
 
 export SparseMatrixCSR
 export SymSparseMatrixCSR
-export push_coo!, sparsecsr, symsparsecsr, getrowptr, getcolval
+export push_coo!, finalize_coo!, sparsecsr, symsparsecsr, getrowptr, getcolval
 
 include("SparseMatrixCSC.jl")
 include("SparseMatrixCSR.jl")

src/SparseMatrixCSC.jl

@@ -7,4 +7,28 @@ function push_coo!(::Type{SparseMatrixCSC},I::Vector{Integer},J::Vector{Integer}
     (push!(I, ik), push!(J, jk), push!(V, vk))
 end
 
+"""
+    function push_coo!(I,J,V,ik,jk,vk) 
+
+Inserts entries in COO vectors for further building a SparseMatrixCSC.
+"""
+function push_coo!(I::Vector{Integer},J::Vector{Integer},V::Vector{Number},ik::Integer,jk::Integer,vk::Number)
+    push_coo!(SparseMatrixCSC,J,V,ik,jk,vk)
+end
+
+"""
+    function finalize_coo!(::Type{SparseMatrixCSC},I,J,V,m,n) 
 
+Check and insert diagonal entries in COO vectors if needed.
+"""
+function finalize_coo!(::Type{SparseMatrixCSC},I::Vector{Integer},J::Vector{Integer},V::Vector{Number},m::Integer,n::Integer)
+end
+
+"""
+    function finalize_coo!(I,J,V,m,n) 
+
+Check and insert diagonal entries in COO vectors if needed.
+"""
+function finalize_coo!(I::Vector{Integer},J::Vector{Integer},V::Vector{Number},m::Integer,n::Integer)
+    finalize_coo!(SparseMatrixCSC,I,J,V,m,n)
+end

src/SparseMatrixCSR.jl

@@ -83,5 +83,14 @@ function push_coo!(::Type{SparseMatrixCSR},I::Vector,J::Vector,V::Vector,ik::Int
     (push!(I, ik), push!(J, jk), push!(V, vk))
 end
 
+"""
+    function finalize_coo!(::Type{SparseMatrixCSR},I,J,V,m,n) 
+
+Check and insert diagonal entries in COO vectors if needed.
+"""
+function finalize_coo!(::Type{SparseMatrixCSR},I::Vector,J::Vector,V::Vector,m::Integer,n::Integer)
+end
+
+
 
 

src/SymSparseMatrixCSR.jl

@@ -80,14 +80,12 @@ end
 
 function symsparsecsr(I,J,V,m,n,combine) 
     m == n || throw(DimensionMismatch("matrix is not square: dimensions are ($m, $n)"))
-    indices = [ i for i in 1:length(I) if !(I[i]<J[i])]
-    # Explicitly store diagonal zeros if needed
-    SymSparseMatrixCSR(sparse(vcat(J[indices],1:m),vcat(I[indices],1:m),vcat(V[indices],zeros(eltype(V),m)),m,m,combine))
+    SymSparseMatrixCSR(sparse(J,I,V,m,n,combine))
 end
 
 
 """
-    function push_coo!(::Type{SparseMatrixCSR},I,J,V,ik,jk,vk) 
+    function push_coo!(::Type{SymSparseMatrixCSR},I,J,V,ik,jk,vk) 
 
 Inserts entries in COO vectors for further building a SymSparseMatrixCSR.
 """
@@ -96,3 +94,26 @@ function push_coo!(::Type{SymSparseMatrixCSR},I::Vector,J::Vector,V::Vector,ik::
     (push!(I, ik), push!(J, jk), push!(V, vk))
 end
 
+"""
+    function finalize_coo!(::Type{SymSparseMatrixCSR},I,J,V,m,n) 
+
+Check and insert diagonal entries in COO vectors if needed.
+"""
+function finalize_coo!(T::Type{SymSparseMatrixCSR},I::Vector,J::Vector,V::Vector, m::Integer, n::Integer)
+    m == n || throw(DimensionMismatch("matrix is not square: dimensions are ($m, $n)"))
+    touched = zeros(Bool,m)
+    for k in 1:length(I)
+        Ik = I[k]
+        Jk = J[k]
+        if Ik == Jk
+            touched[Ik] = true
+        end
+    end
+    for k in 1:m
+        if ! touched[k]
+            push_coo!(T,I,J,V,k,k,zero(eltype(V)))
+        end
+    end
+end
+
+

test/SparseMatrixCSR.jl

@@ -10,15 +10,16 @@
         for (ik, jk, vk) in zip(rand(1:maxrows, maxnz), rand(1:maxcols, maxnz), rand(1:T(maxnz), maxnz))
             push_coo!(SparseMatrixCSR,I,J,V,ik,jk,vk)
         end
-        CSC = sparse(I, J, V)
-        CSR = sparsecsr(I, J, V)
+        finalize_coo!(SparseMatrixCSR,I,J,V,maxcols,maxrows)
+        CSC = sparse(I, J, V, maxcols,maxrows)
+        CSR = sparsecsr(I, J, V,maxcols,maxrows)
 
         @test CSC == CSR
 
         @test nnz(CSC) == count(i->(i!=0), CSC) == nnz(CSR) == count(i->(i!=0), CSR)
 
-        TCSC = sparse(J, I, V)
-        TCSR = sparsecsr(J, I, V)
+        TCSC = sparse(J, I, V, maxrows, maxcols)
+        TCSR = sparsecsr(J, I, V, maxrows, maxcols)
 
         @test size(CSC)==size(CSR)==reverse(size(CSR.transpose))
         @test size(CSC)==size(CSR)==reverse(size(TCSC))==reverse(size(TCSC))

test/SymSparseMatrixCSR.jl

@@ -7,9 +7,10 @@
         I = Vector{Int}()
         J = Vector{Int}()
         V = Vector{T}()
-        for (ik, jk, vk) in zip(vcat(rand(1:maxrows, maxnz),1:maxrows), vcat(rand(1:maxcols, maxnz),1:maxcols), vcat(rand(1:T(maxnz), maxnz), zeros(T,maxnz)))
+        for (ik, jk, vk) in zip(rand(1:maxrows, maxnz), rand(1:maxcols, maxnz), rand(1:T(maxnz), maxnz) )
             push_coo!(SymSparseMatrixCSR,I,J,V,ik,jk,vk)
         end
+        finalize_coo!(SymSparseMatrixCSR,I,J,V,maxrows, maxcols)
         SYMCSC = Symmetric(sparse(I, J, V, maxrows, maxcols),:L)
         SYMCSR = symsparsecsr(I, J, V, maxrows, maxcols)