add tranpose operator for matrices

Author: abhinavmehndiratta

src/Interface/Interface.jl

@@ -3,7 +3,7 @@ module Interface
 using SuiteSparseGraphBLAS
 
 import Base:
-    getindex, setindex!, empty!, copy, size, ==
+    getindex, setindex!, empty!, copy, size, adjoint, ==
 
 import SuiteSparseGraphBLAS:
     GrB_Info, GrB_Index, GrB_Matrix, GrB_Vector, GrB_Descriptor, GrB_Desc_Field, GrB_Desc_Value,

src/Interface/Object_Methods/Matrix_Methods.jl

@@ -114,7 +114,12 @@ function ==(A::GrB_Matrix{T}, B::GrB_Matrix{U}) where {T, U}
     C = GrB_Matrix(Bool, Asize...)
     op = equal_op(T)
 
-    GrB_eWiseMult(C, GrB_NULL, GrB_NULL, op, A, B, GrB_NULL)
+    res = GrB_eWiseMult(C, GrB_NULL, GrB_NULL, op, A, B, GrB_NULL)
+
+    if res != GrB_SUCCESS
+        GrB_free(C)
+        error(res)
+    end
 
     if nnz(C) != Anvals
         GrB_free(C)
@@ -125,6 +130,10 @@ function ==(A::GrB_Matrix{T}, B::GrB_Matrix{U}) where {T, U}
 
     GrB_free(C)
 
+    if typeof(result) == GrB_Info
+        error(result)
+    end
+
     return result
 end
 
@@ -364,6 +373,34 @@ function copy(A::GrB_Matrix{T}) where T <: valid_types
     return C
 end
 
+"""
+    adjoint(A)
+
+Compute transpose of a GraphBLAS matrix.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> GrB_init(GrB_NONBLOCKING)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> M = GrB_Matrix([1, 1], [2, 3], [1, 1])
+GrB_Matrix{Int64}
+
+julia> findnz(M')
+([2, 3], [1, 1], [1, 1])
+```
+"""
+function adjoint(A::GrB_Matrix{T}) where T <: valid_types
+    C = GrB_Matrix(T, size(A, 2), size(A, 1))
+    res = GrB_transpose(C, GrB_NULL, GrB_NULL, A, GrB_NULL)
+    if res != GrB_SUCCESS
+        error(res)
+    end
+    return C
+end
+
 """
     LowerTriangular(A)
 
@@ -375,7 +412,10 @@ function LowerTriangular(A::GrB_Matrix{T}) where T <: valid_types
         error("Matrix is not square")
     end
     L = GrB_Matrix(T, nrows, ncols)
-    GxB_select(L, GrB_NULL, GrB_NULL, GxB_TRIL, A, 0, GrB_NULL)
+    res = GxB_select(L, GrB_NULL, GrB_NULL, GxB_TRIL, A, 0, GrB_NULL)
+    if res != GrB_SUCCESS
+        error(res)
+    end
     return L
 end
 
@@ -390,7 +430,10 @@ function UpperTriangular(A::GrB_Matrix{T}) where T <: valid_types
         error("Matrix is not square")
     end
     U = GrB_Matrix(T, nrows, ncols)
-    GxB_select(U, GrB_NULL, GrB_NULL, GxB_TRIU, A, 0, GrB_NULL)
+    res = GxB_select(U, GrB_NULL, GrB_NULL, GxB_TRIU, A, 0, GrB_NULL)
+    if res != GrB_SUCCESS
+        error(res)
+    end
     return U
 end
 
@@ -402,6 +445,9 @@ Return diagonal of a GraphBLAS matrix.
 function Diagonal(A::GrB_Matrix{T}) where T <: valid_types 
     nrows, ncols = size(A)
     D = GrB_Matrix(T, nrows, ncols)
-    GxB_select(D, GrB_NULL, GrB_NULL, GxB_DIAG, A, 0, GrB_NULL)
+    res = GxB_select(D, GrB_NULL, GrB_NULL, GxB_DIAG, A, 0, GrB_NULL)
+    if res != GrB_SUCCESS
+        error(res)
+    end
     return D
 end