add free methods

Author: abhinavmehndiratta

src/Object_Methods/Free_Objects.jl

@@ -0,0 +1,181 @@
+"""
+    GrB_free(object)
+
+Generic method to free a GraphBLAS object.
+
+# Examples
+```jldoctest
+julia> using SuiteSparseGraphBLAS
+
+julia> w = GrB_Vector{Int64}()
+GrB_Vector{Int64}
+
+julia> I = [0, 2, 4]; X = [10, 20, 30]; n = 3;
+
+julia> GrB_Vector_new(w, GrB_INT64, 5)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> GrB_Vector_build(w, I, X, n, GrB_FIRST_INT64)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> @GxB_fprint(w, GxB_COMPLETE)
+
+GraphBLAS vector: w
+nrows: 5 ncols: 1 max # entries: 3
+format: standard CSC vlen: 5 nvec_nonempty: 1 nvec: 1 plen: 1 vdim: 1
+hyper_ratio 0.0625
+GraphBLAS type:  int64_t size: 8
+number of entries: 3
+column: 0 : 3 entries [0:2]
+    row 0: int64 10
+    row 2: int64 20
+    row 4: int64 30
+
+
+julia> GrB_free(w)
+GrB_SUCCESS::GrB_Info = 0
+
+julia> @GxB_fprint(w, GxB_COMPLETE)
+
+GraphBLAS vector: w NULL
+```
+"""
+function GrB_free(object::GrB_Struct)
+    object_ptr = pointer_from_objref(object)
+    fn_name = "GrB_" * get_struct_name(object) * "_free"
+
+    return GrB_Info(
+        ccall(
+                dlsym(graphblas_lib, fn_name),
+                Cint,
+                (Ptr{Cvoid}, ),
+                object_ptr
+            )
+        )
+end
+
+"""
+    GrB_UnaryOp_free(unaryop)
+
+Free unary operator.
+"""
+function GrB_UnaryOp_free(unaryop::GrB_UnaryOp)
+    unaryop_ptr = pointer_from_objref(unaryop)
+
+    return GrB_Info(
+        ccall(
+                dlsym(graphblas_lib, "GrB_UnaryOp_free"),
+                Cint,
+                (Ptr{Cvoid}, ),
+                unaryop_ptr
+            )
+        )
+end
+
+"""
+    GrB_BinaryOp_free(binaryop)
+
+Free binary operator.
+"""
+function GrB_BinaryOp_free(binaryop::GrB_BinaryOp)
+    binaryop_ptr = pointer_from_objref(binaryop)
+
+    return GrB_Info(
+        ccall(
+                dlsym(graphblas_lib, "GrB_BinaryOp_free"),
+                Cint,
+                (Ptr{Cvoid}, ),
+                binaryop_ptr
+            )
+        )
+end
+
+"""
+    GrB_Monoid_free(monoid)
+
+Free monoid.
+"""
+function GrB_Monoid_free(monoid::GrB_Monoid)
+    monoid_ptr = pointer_from_objref(monoid)
+
+    return GrB_Info(
+        ccall(
+                dlsym(graphblas_lib, "GrB_Monoid_free"),
+                Cint,
+                (Ptr{Cvoid}, ),
+                monoid_ptr
+            )
+        )
+end
+
+"""
+    GrB_Semiring_free(semiring)
+
+Free semiring.
+"""
+function GrB_Semiring_free(semiring::GrB_Semiring)
+    semiring_ptr = pointer_from_objref(semiring)
+
+    return GrB_Info(
+        ccall(
+                dlsym(graphblas_lib, "GrB_Semiring_free"),
+                Cint,
+                (Ptr{Cvoid}, ),
+                semiring_ptr
+            )
+        )
+end
+
+"""
+    GrB_Vector_free(v)
+
+Free vector.
+"""
+function GrB_Vector_free(v::GrB_Vector)
+    v_ptr = pointer_from_objref(v)
+
+    return GrB_Info(
+        ccall(
+                dlsym(graphblas_lib, "GrB_Vector_free"),
+                Cint,
+                (Ptr{Cvoid}, ),
+                v_ptr
+            )
+        )
+end
+
+"""
+    GrB_Matrix_free(A)
+
+Free matrix.
+"""
+function GrB_Matrix_free(A::GrB_Matrix)
+    A_ptr = pointer_from_objref(A)
+
+    return GrB_Info(
+        ccall(
+                dlsym(graphblas_lib, "GrB_Matrix_free"),
+                Cint,
+                (Ptr{Cvoid}, ),
+                A_ptr
+            )
+        )
+end
+
+"""
+    GrB_Descriptor_free(desc)
+
+Free descriptor.
+"""
+function GrB_Descriptor_free(desc::GrB_Descriptor)
+    desc_ptr = pointer_from_objref(desc)
+
+    return GrB_Info(
+        ccall(
+                dlsym(graphblas_lib, "GrB_Descriptor_free"),
+                Cint,
+                (Ptr{Cvoid}, ),
+                desc_ptr
+            )
+        )
+end

src/SuiteSparseGraphBLAS.jl

@@ -146,6 +146,7 @@ include("Object_Methods/Vector_Methods.jl")
 include("Object_Methods/Algebra_Methods.jl")
 include("Object_Methods/Descriptor_Methods.jl")
 include("Object_Methods/Print_Objects.jl")
+include("Object_Methods/Free_Objects.jl")
 include("Operations/Multiplication.jl")
 include("Operations/Element_wise_multiplication.jl")
 include("Operations/Element_wise_addition.jl")
@@ -174,6 +175,10 @@ GrB_Descriptor_new, GrB_Descriptor_set,
 # Algebra Methods
 GrB_UnaryOp_new, GrB_BinaryOp_new, GrB_Monoid_new, GrB_Semiring_new,
 
+# Free Methods
+GrB_free, GrB_UnaryOp_free, GrB_BinaryOp_free, GrB_Monoid_free, GrB_Semiring_free,
+GrB_Vector_free, GrB_Matrix_free, GrB_Descriptor_free,
+
 # Print functions
 @GxB_UnaryOp_fprint, @GxB_BinaryOp_fprint, @GxB_Monoid_fprint, @GxB_Semiring_fprint,
 @GxB_Matrix_fprint, @GxB_Vector_fprint, @GxB_Descriptor_fprint, @GxB_fprint,