sort functionality and a note about internal aliasing

Author: rayegun

src/SuiteSparseGraphBLAS.jl

@@ -67,14 +67,15 @@ include("operations/reduce.jl")
 include("operations/kronecker.jl")
 include("operations/concat.jl")
 include("operations/resize.jl")
+include("operations/sort.jl")
 # 
 include("print.jl")
 include("import.jl")
 include("export.jl")
 include("pack.jl")
 include("unpack.jl")
 include("options.jl")
-#EXPERIMENTAL
+
 include("operations/broadcasts.jl")
 include("chainrules/chainruleutils.jl")
 include("chainrules/mulrules.jl")
@@ -83,6 +84,8 @@ include("chainrules/maprules.jl")
 include("chainrules/reducerules.jl")
 include("chainrules/selectrules.jl")
 include("chainrules/constructorrules.jl")
+
+#EXPERIMENTAL
 include("misc.jl")
 include("asjulia.jl")
 include("spmgb/sparsemat.jl")

src/operations/sort.jl

@@ -0,0 +1,53 @@
+# inplace sorts
+function Base.sort!(
+    C::Union{GBArray, Nothing}, #output matrix, possibly aliased with A, 
+    #or Nothing if just interested in P
+    P::Union{GBArray, Nothing}, # permutation matrix, possibly Nothing if just interested in C
+    A::GBArray; #input matrix, possibly aliased with C.
+    dims = nothing,
+    lt = <,
+    desc = nothing
+    # We only support a limited set of the keywords for now.
+    # Missing by, rev, order, alg
+)
+    A isa GBMatOrTranspose && dims === nothing && throw(ArgumentError("dims must be either 1 (sort columns) or 2 (sort rows) for matrix arguments."))
+    A isa GBVector && (dims = 1)
+    C, P = _handlenothings(C, P)
+    C == C_NULL && P == C_NULL && throw(ArgumentError("One (or both) of C and P must not be nothing."))
+    op = BinaryOp(lt)(eltype(A))
+    if dims == 1
+        transpose = true
+    elseif dims == 2
+        transpose = false
+    else
+        throw(ArgumentError("dims must be either 1 (sort columns) or 2 (sort rows)"))
+    end
+    desc = _handledescriptor(desc; in1=A)
+    desc.transpose_input1 = transpose
+    @wraperror LibGraphBLAS.GxB_Matrix_sort(C, P, op, parent(A), desc)
+    return C
+end
+
+function Base.sort!(A::GBArray; dims = nothing, lt = <, desc = nothing)
+    return sort!(A, nothing, A; dims, lt, desc)
+end
+
+function Base.sort!(C::GBArray, A::GBArray; dims, lt = <, desc = nothing)
+    return sort!(C, nothing, A; dims, lt, desc)
+end
+
+function Base.sortperm!(P::GBArray, A::GBArray; dims = nothing, lt = <, desc = nothing)
+    sort!(nothing, P, A; dims, lt, desc)
+    return P
+end
+
+function Base.sort(A::GBArray; dims = nothing, lt = <, desc = nothing)
+    C = similar(A)
+    return sort!(C, A; dims, lt, desc)
+end
+
+function Base.sortperm(A::GBArray; dims = nothing, lt = <, desc = nothing)
+    P = similar(A, Int64)
+    return sortperm!(P, A; dims, lt, desc)
+end
+

src/types.jl

@@ -254,6 +254,8 @@ The storage type is automatically determined by the library.
 """
 mutable struct GBMatrix{T} <: AbstractSparseArray{T, UInt64, 2}
     p::LibGraphBLAS.GrB_Matrix
+    # NOTE WELL: The alias kwarg IS NOT for public use.
+    # It is used in very few places to convert a GBVector to a GBMatrix internally.
     function GBMatrix{T}(p::LibGraphBLAS.GrB_Matrix; aliased=false) where {T}
         A = new(p)
         function f(matrix)