add built in select operators

Author: abhinavmehndiratta

src/Operations/Select.jl

@@ -0,0 +1,47 @@
+function GxB_select(C::T, Mask, accum, op, A::T, k, desc) where T
+    if T <: GrB_Matrix
+        return GxB_Matrix_select(C, Mask, accum, op, A, k, desc)
+    elseif T <: GrB_Vector
+        return GxB_Vectorselect(C, Mask, accum, op, A, k, desc)
+    end
+end
+
+function GxB_Vector_select(             # w<mask> = accum (w, op(u,k))
+        w::GrB_Vector,                  # input/output vector for results
+        mask::T,                        # optional mask for w, unused if NULL
+        accum::U,                       # optional accum for z=accum(w,t)
+        op::GxB_SelectOp,               # operator to apply to the entries
+        u::GrB_Vector,                  # first input:  vector u
+        thunk,                          # optional input for the select operator
+        desc::V                         # descriptor for w and mask
+) where {T <: valid_vector_mask_types, U <: valid_accum_types, V <: valid_desc_types}
+
+    return GrB_Info(
+                ccall(
+                        dlsym(graphblas_lib, "GxB_Vector_select"),
+                        Cint,
+                        (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
+                        w.p, mask.p, accum.p, op.p, u.p, Ref(thunk), desc.p
+                    )
+                )
+end
+
+function GxB_Matrix_select(             # C<Mask> = accum (C, op(A,k)) or op(A',k)
+        C::GrB_Matrix,                  # input/output matrix for results
+        Mask::T,                        # optional mask for C, unused if NULL
+        accum::U,                       # optional accum for Z=accum(C,T)
+        op::GxB_SelectOp,               # operator to apply to the entries
+        A::GrB_Matrix,                  # first input:  matrix A
+        thunk,                          # optional input for the select operator
+        desc::V                         # descriptor for C, mask, and A
+) where {T <: valid_matrix_mask_types, U <: valid_accum_types, V <: valid_desc_types}
+
+    return GrB_Info(
+                ccall(
+                        dlsym(graphblas_lib, "GxB_Matrix_select"),
+                        Cint,
+                        (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
+                        C.p, Mask.p, accum.p, op.p, A.p, Ref(thunk), desc.p
+                    )
+                )
+end

src/Structures.jl

@@ -9,7 +9,7 @@ abstract type GrB_Struct end
 mutable struct GrB_Type{T} <: GrB_Struct
     p::Ptr{Cvoid}
 end
-GrB_Type{T}() where T = GrB_Type{T}(C_NULL) 
+GrB_Type{T}() where T = GrB_Type{T}(C_NULL)
 Base.show(io::IO, ::GrB_Type{T}) where T = print("GrB_Type{" * string(T) * "}")
 
 mutable struct GrB_UnaryOp <: GrB_Struct
@@ -54,13 +54,19 @@ end
 GrB_Descriptor() = GrB_Descriptor(C_NULL)
 Base.show(io::IO, ::GrB_Descriptor) = print("GrB_Descriptor")
 
+mutable struct GxB_SelectOp
+    p::Ptr{Cvoid}
+end
+GxB_SelectOp() = GxB_SelectOp(C_NULL)
+Base.show(io::IO, ::GxB_SelectOp) = print("GxB_SelectOp")
+
 struct GrB_NULL_Type
-    p::Ptr{Cvoid} 
+    p::Ptr{Cvoid}
 end
 Base.show(io::IO, ::GrB_NULL_Type) = print("GrB_NULL")
 
 mutable struct GrB_ALL_Type
-    p::Ptr{Cvoid} 
+    p::Ptr{Cvoid}
 end
 Base.pointer(x::GrB_ALL_Type) = x.p
 Base.show(io::IO, ::GrB_ALL_Type) = print("GrB_ALL")

src/SuiteSparseGraphBLAS.jl

@@ -66,6 +66,8 @@ const GrB_LNOT = GrB_UnaryOp()
 const GrB_LOR = GrB_BinaryOp(); const GrB_LAND = GrB_BinaryOp(); const GrB_LXOR = GrB_BinaryOp()
 const GxB_LOR_BOOL_MONOID = GrB_Monoid(); const GxB_LAND_BOOL_MONOID = GrB_Monoid()
 const GxB_LXOR_BOOL_MONOID = GrB_Monoid(); const GxB_EQ_BOOL_MONOID = GrB_Monoid()
+const GxB_TRIL = GxB_SelectOp(); const GxB_TRIU = GxB_SelectOp(); const GxB_DIAG = GxB_SelectOp();
+const GxB_OFFDIAG = GxB_SelectOp(); GxB_NONZERO = GxB_SelectOp()
 
 graphblas_lib = C_NULL
 
@@ -137,6 +139,13 @@ function __init__()
         varname = "GxB_" * bool_s * "_" * "BOOL"
         @eval const $(Symbol(varname)) = $(GrB_Semiring(load_global(varname)))
     end
+
+    #load global select operators
+    GxB_TRIL.p = load_global("GxB_TRIL")
+    GxB_TRIU.p = load_global("GxB_TRIU")
+    GxB_DIAG.p = load_global("GxB_DIAG")
+    GxB_OFFDIAG.p = load_global("GxB_OFFDIAG")
+    GxB_NONZERO.p = load_global("GxB_NONZERO")
 end
 
 include("Enums.jl")
@@ -155,6 +164,7 @@ include("Operations/Apply.jl")
 include("Operations/Assign.jl")
 include("Operations/Reduce.jl")
 include("Operations/Transpose.jl")
+include("Operations/Select.jl")
 
 export
 # Context Methods
@@ -212,7 +222,10 @@ GrB_reduce, GrB_Matrix_reduce_Monoid, GrB_Matrix_reduce_BinaryOp, GrB_Matrix_red
 GrB_Vector_reduce,
 
 # Transpose
-GrB_transpose
+GrB_transpose,
+
+# Select
+GxB_Vector_select, GxB_Matrix_select, GxB_select
 
 # Export global variables
 
@@ -261,6 +274,9 @@ for bool_s in built_in_boolean_semirings
     @eval export $(Symbol(varname))
 end
 
+# Select Operators
+export GxB_TRIL, GxB_TRIU, GxB_OFFDIAG, GxB_DIAG, GxB_NONZERO
+
 # Enums
 export GrB_Info
 for s in instances(GrB_Info)