add descriptor methods

Author: abhinavmehndiratta

src/Enums.jl

@@ -34,3 +34,21 @@ end
     GxB_SHORT = 2                   # short description about 30 entries of a matrix
     GxB_COMPLETE = 3                # print the entire contents of the object
 end
+
+@enum GrB_Desc_Field begin
+    GrB_OUTP = 0                    # descriptor for output of a method
+    GrB_MASK = 1                    # descriptor for the mask input of a method
+    GrB_INP0 = 2                    # descriptor for the first input of a method
+    GrB_INP1 = 3                    # descriptor for the second input of a method
+end
+
+@enum GrB_Desc_Value begin
+    # for all GrB_Descriptor fields:
+    GxB_DEFAULT = 0                 # default behavior of the method
+    # for GrB_OUTP only:
+    GrB_REPLACE = 1                 # clear the output before assigning new values to it
+    # for GrB_MASK only:
+    GrB_SCMP = 2                    # use the structural complement of the input
+    # for GrB_INP0 and GrB_INP1 only:
+    GrB_TRAN = 3                    # use the transpose of the input
+end

src/Object_Methods/Descriptor_Methods.jl

@@ -0,0 +1,23 @@
+function GrB_Descriptor_new(descriptor::GrB_Descriptor)
+    desc_ptr = pointer_from_objref(descriptor)
+    
+    return GrB_Info(
+        ccall(
+                dlsym(graphblas_lib, "GrB_Descriptor_new"),
+                Cint,
+                (Ptr{Cvoid}, ),
+                desc_ptr
+            )
+        )
+end
+
+function GrB_Descriptor_set(desc::GrB_Descriptor, field::GrB_Desc_Field, val::GrB_Desc_Value)
+    return GrB_Info(
+        ccall(
+                dlsym(graphblas_lib, "GrB_Descriptor_set"),
+                Cint,
+                (Ptr{Cvoid}, Cint, Cint),
+                desc.p, field, val
+            )
+        )
+end

src/Object_Methods/Print_Objects.jl

@@ -27,3 +27,18 @@ macro GxB_Vector_fprint(v, pr)
     name = string(v)
     return :(GxB_Vector_fprint($(esc(v)), $name, $pr))
 end
+
+function GxB_Descriptor_fprint(desc::GrB_Descriptor, name::String, pr::GxB_Print_Level)
+    function fn(path, io)
+        FILE = Libc.FILE(io)
+        ccall(dlsym(graphblas_lib, "GxB_Descriptor_fprint"), Cint, (Ptr{Cvoid}, Ptr{UInt8}, Cint, Ptr{Cvoid}), desc.p, pointer(name), pr, FILE)
+        ccall(:fclose, Cint, (Ptr{Cvoid},), FILE)
+        foreach(println, eachline(path))
+    end
+    mktemp(fn)
+end
+
+macro GxB_Descriptor_fprint(desc, pr)
+    name = string(desc)
+    return :(GxB_Descriptor_fprint($(esc(desc)), $name, $pr))
+end

src/Structures.jl

@@ -1,6 +1,6 @@
 import Base.show
 import Base.==
-export GrB_Type, GrB_UnaryOp, GrB_BinaryOp, GrB_Vector, GrB_Matrix
+export GrB_Type, GrB_UnaryOp, GrB_BinaryOp, GrB_Vector, GrB_Matrix, GrB_Descriptor
 
 mutable struct GrB_Type
     p::Ptr{Cvoid}
@@ -34,3 +34,9 @@ mutable struct GrB_Matrix{T}
 end
 GrB_Matrix{T}() where T = GrB_Matrix{T}(Ptr{Cvoid}(0))
 Base.show(io::IO, ::GrB_Matrix{T}) where T = print("GrB_Matrix{" * string(T) * "}")
+
+mutable struct GrB_Descriptor
+    p::Ptr{Cvoid}
+end
+GrB_Descriptor() = GrB_Descriptor(Ptr{Cvoid}(0))
+Base.show(io::IO, ::GrB_Descriptor) = print("GrB_Descriptor")

src/SuiteSparseGraphBLAS.jl

@@ -72,6 +72,7 @@ include("Context_Methods.jl")
 include("Utils.jl")
 include("Object_Methods/Matrix_Methods.jl")
 include("Object_Methods/Vector_Methods.jl")
+include("Object_Methods/Descriptor_Methods.jl")
 include("Object_Methods/Print_Objects.jl")
 
 export
@@ -87,8 +88,11 @@ GrB_Matrix_extractElement, GrB_Matrix_extractTuples,
 GrB_Vector_new, GrB_Vector_build, GrB_Vector_dup, GrB_Vector_clear, GrB_Vector_size,
 GrB_Vector_nvals, GrB_Vector_setElement, GrB_Vector_extractElement, GrB_Vector_extractTuples,
 
+# Descriptor Methods
+GrB_Descriptor_new, GrB_Descriptor_set,
+
 # Print functions
-@GxB_Matrix_fprint, @GxB_Vector_fprint
+@GxB_Matrix_fprint, @GxB_Vector_fprint, @GxB_Descriptor_fprint
 
 # Export global variables
 
@@ -116,16 +120,28 @@ for op in binary_operators
 end
 
 # Enums
+export GrB_Info
 for s in instances(GrB_Info)
     @eval export $(Symbol(s))
 end
 
+export GrB_Mode
 for s in instances(GrB_Mode)
     @eval export $(Symbol(s))
 end
 
+export GxB_Print_Level
 for s in instances(GxB_Print_Level)
     @eval export $(Symbol(s))
 end
 
+export GrB_Desc_Field
+for s in instances(GrB_Desc_Field)
+    @eval export $(Symbol(s))
+end
+
+export GrB_Desc_Value
+for s in instances(GrB_Desc_Value)
+    @eval export $(Symbol(s))
+end
 end #end of module