Merge pull request #3 from gridap/add/Idx-based_SparseMatrixCSR

Add idx-based SparseMatrixCSR

Author: victorsndvg

Project.toml

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

README.md

@@ -9,8 +9,6 @@ Compressed Sparse Row (CSR) sparse matrix implementations.
 
 It includes `SparseMatrixCSR` and `SymSparseMatrixCSR` wrappers.
 
-CSR wrappers relies on `SparseMatrixCSC` native Julia type.
-
 ## Basic Usage
 
 ```julia

src/SparseMatricesCSR.jl

@@ -1,14 +1,44 @@
+"""
+This module contains:
+
+  - Data types:
+    + `SparseMatrixCSR`:Compressed Sparse Row (CSR) sparse matrix implementation with Bi-based indexing.
+    + `SymSparseMatrixCSR`: Symmetric Compressed Sparse Row sparse matrix implementation with Bi-based indexing.
+
+  - Procedures:
+    + `push_coo!`: Helper function to build COO arrays for further building a SparseMatrix
+    + `finalize_coo!`: Finalization of COO arrays building.
+    + `sparsecsr`: Analogous method to [`sparse`](@ref) function to build a SparseMatrixCSR.
+    + `symsparsecsr`: Analogous method to [`sparse`](@ref) function to build a SymSparseMatrixCSR.
+    + `colvals`: Analogous method to [`rowvals`](@ref) to return `colvals` array.
+    + `hasrowmajororder`: Return `true` if matrix values are ordered by row.
+    + `hascolmajororder`: Return `true` if matrix values are ordered by column.
+    + `getptr`: Return the pointer array of a SparseMatrix (`rowptr` or `colptr` depending on the SparseMatrix type)
+    + `getindices`: Return the indices array of a SparseMatrix (`rowval` or `colval` depending on the SparseMatrix type)
+
+  - Overloaded procedures:
+    + `*`: SparseMatrix-Vector product.
+    + `mul!`: SparseMatrix-Vector product.
+    + `nnz`: Return the number of stored (filled) elements in a sparse array.
+    + `nonzeros`: Return `nzval` array.
+    + `nzrange`: Return the range of indices for a particular row or column (Depending on the SparseMatrix type)
+    + `findnz`: Return a tuple (I, J, V) where I and J are the row and column indices.
+    + `rowvals`: Return row indices or raises an error (Depending on the SparseMatrix type)
+
+"""
 module SparseMatricesCSR
 
 using SparseArrays
 using LinearAlgebra
 
-import Base: size, getindex, show, count
-import SparseArrays: nnz, getnzval, nzvalview, nonzeros, nzrange, findnz
+import Base: size, getindex, show, count, *
+import LinearAlgebra: mul!
+import SparseArrays: nnz, getnzval, nonzeros, nzrange, findnz, rowvals
 
 export SparseMatrixCSR
 export SymSparseMatrixCSR
-export push_coo!, finalize_coo!, sparsecsr, symsparsecsr, getrowptr, getcolval
+export push_coo!, finalize_coo!, sparsecsr, symsparsecsr, colvals
+export hasrowmajororder, hascolmajororder, getptr, getindices
 
 include("SparseMatrixCSC.jl")
 include("SparseMatrixCSR.jl")

src/SparseMatrixCSC.jl

@@ -27,8 +27,43 @@ end
 """
     function finalize_coo!(I,J,V,m,n) 
 
-Check and insert diagonal entries in COO vectors if needed.
+Finalize COO arrays for building a SparseMatrixCSC.
 """
 function finalize_coo!(I::Vector,J::Vector,V::Vector,m::Integer,n::Integer)
     finalize_coo!(SparseMatrixCSC,I,J,V,m,n)
 end
+
+
+"""
+    function hasrowmajororder(::Type{SparseMatrixCSC})
+
+Check if values are stored in row-major order.
+Return false.
+"""
+hasrowmajororder(::Type{SparseMatrixCSC}) = false
+hasrowmajororder(a::SparseMatrixCSC) = hasrowmajororder(SparseMatrixCSC)
+
+"""
+    function hascolmajororder(::Type{SparseMatrixCSC})
+
+Check if values are stored in col-major order.
+Return true.
+"""
+hascolmajororder(::Type{SparseMatrixCSC}) = true
+hascolmajororder(a::SparseMatrixCSC) = hascolmajororder(SparseMatrixCSC)
+
+"""
+    function getptr(S::SparseMatrixCSC)
+
+Return columns pointer.
+"""
+getptr(S::SparseMatrixCSC) = S.colptr
+
+"""
+    function getvals(S::SparseMatrixCSC)
+
+Return row indices.
+"""
+getindices(S::SparseMatrixCSC) = rowvals(S)
+
+