add equality operator for matrices and vectors

Author: abhinavmehndiratta

src/Interface/Interface.jl

@@ -3,11 +3,11 @@ module Interface
 using SuiteSparseGraphBLAS
 
 import Base:
-    getindex, setindex!, empty!, copy, size
+    getindex, setindex!, empty!, copy, size, ==
 
 import SuiteSparseGraphBLAS:
     GrB_Info, GrB_Index, GrB_Matrix, GrB_Vector, GrB_Descriptor, GrB_Desc_Field, GrB_Desc_Value,
-    valid_types, get_GrB_Type, default_dup
+    valid_types, get_GrB_Type, default_dup, equal_op
 
 include("./Object_Methods/Matrix_Methods.jl")
 include("./Object_Methods/Vector_Methods.jl")

src/Interface/Object_Methods/Matrix_Methods.jl

@@ -68,6 +68,66 @@ function GrB_Matrix(T::DataType, nrows::GrB_Index, ncols::GrB_Index)
     return A
 end
 
+"""
+    ==(A, B)
+
+Check if two GraphBLAS matrices are equal.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> A = GrB_Matrix([1, 2, 3], [2, 4, 5], [1, 1, 1])
+GrB_Matrix{Int64}
+
+julia> B = GrB_Matrix([1, 2, 3], [2, 4, 5], [1, 1, 1])
+GrB_Matrix{Int64}
+
+julia> A == B
+true
+
+julia> B = GrB_Matrix([1, 2, 3], [2, 4, 5], [1, 1, 2])
+GrB_Matrix{Int64}
+
+julia> A == B
+false
+
+julia> B = GrB_Matrix([1, 2, 3], [2, 4, 3], [1, 1, 1])
+GrB_Matrix{Int64}
+
+julia> A == B
+false
+```
+"""
+function ==(A::GrB_Matrix{T}, B::GrB_Matrix{U}) where {T, U}
+    T != U && return false
+
+    Asize = size(A)
+    Anvals = nnz(A)
+
+    Asize == size(B) || return false
+    Anvals == nnz(B) || return false
+
+    C = GrB_Matrix(Bool, Asize...)
+    op = equal_op(T)
+
+    GrB_eWiseMult(C, GrB_NULL, GrB_NULL, op, A, B, GrB_NULL)
+
+    if nnz(C) != Anvals
+        GrB_free(C)
+        return false
+    end
+
+    result = GrB_reduce(GrB_NULL, GxB_LAND_BOOL_MONOID, C, GrB_NULL)
+
+    GrB_free(C)
+
+    return result
+end
+
 """
     findnz(A)
 

src/Interface/Object_Methods/Vector_Methods.jl

@@ -78,6 +78,54 @@ function GrB_Vector(T::DataType, n::GrB_Index)
     return V
 end
 
+"""
+    ==(A, B)
+
+Check if two GraphBLAS vectors are equal.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> A = GrB_Vector([1, 3, 4], [1, 1, 1])
+GrB_Vector{Int64}
+
+julia> B = GrB_Vector([1, 3, 4], [1, 1, 1])
+GrB_Vector{Int64}
+
+julia> A == B
+true
+```
+"""
+function ==(A::GrB_Vector{T}, B::GrB_Vector{U}) where {T, U}
+    T != U && return false
+
+    Asize = size(A)
+    Anvals = nnz(A)
+
+    Asize == size(B) || return false
+    Anvals == nnz(B) || return false
+
+    C = GrB_Vector(Bool, Asize[1])
+    op = equal_op(T)
+
+    GrB_eWiseMult(C, GrB_NULL, GrB_NULL, op, A, B, GrB_NULL)
+
+    if nnz(C) != Anvals
+        GrB_free(C)
+        return false
+    end
+
+    result = GrB_reduce(GrB_NULL, GxB_LAND_BOOL_MONOID, C, GrB_NULL)
+
+    GrB_free(C)
+
+    return result
+end
+
 """
     size(V,[ dim])
 

src/Utils.jl

@@ -73,13 +73,47 @@ function default_dup(T::DataType)
     return GrB_FIRST_FP64
 end
 
-function get_struct_name(A::GrB_Struct)
-    s = ""
-    for i in string(typeof(A))[5:end]
-        i == '{' && break
-        s *= i
+function equal_op(T::DataType)
+    if T == Bool
+        return GrB_EQ_BOOL
+    elseif T == Int8
+        return GrB_EQ_INT8
+    elseif T == UInt8
+        return GrB_EQ_UINT8
+    elseif T == Int16
+        return GrB_EQ_INT16
+    elseif T == UInt16
+        return GrB_EQ_UINT16
+    elseif T == Int32
+        return GrB_EQ_INT32
+    elseif T == UInt32
+        return GrB_EQ_UINT32
+    elseif T == Int64
+        return GrB_EQ_INT64
+    elseif T == UInt64
+        return GrB_EQ_UINT64
+    elseif  T == Float32
+        return GrB_EQ_FP32
+    end
+    return GrB_EQ_FP64
+end
+
+function get_struct_name(object::GrB_Struct)
+    T = typeof(object)
+    if T <: GrB_UnaryOp
+        return "UnaryOp"
+    elseif T <: GrB_BinaryOp
+        return "BinaryOp"
+    elseif T <: GrB_Monoid
+        return "Monoid"
+    elseif T <: GrB_Semiring
+        return "Semiring"
+    elseif T <: GrB_Vector
+        return "Vector"
+    elseif T <: GrB_Matrix
+        return "Matrix"
     end
-    return s
+    return "Descriptor"
 end
 
 function _GrB_Index(x::T) where T <: GrB_Index