improve semirings docs

Author: Wimmerer

docs/src/semirings.md

@@ -18,7 +18,9 @@ There are over 200 built-in semirings available as constants in the `Semirings`
 - Boolean semiring $(\vee, \wedge)$ available as `Semirings.LOR_LAND`. 
 - GF2, the two-element Galois Field $(\text{xor}, \wedge)$, available as `Semirings.LXOR_LAND`.
 
-Below is the list of built-ins with the two binary operators as well as the domains available listed for each semiring.
+Below are the built-in semirings available, along with their associated monoids, binary operators, and types.
+For common semirings where the binary operator and monoid have equivalent julia functions, those functions are listed.
+
 
 !!! note
     In all cases the input and output types of the semirings are the same, **except** for cases where the "add" types and "multiply" output output types are boolean, such as in `LAND_GE`.
@@ -30,24 +32,23 @@ cd("..")
 using SuiteSparseGraphBLAS
 using Latexify
 head = ["Semiring", "⊕", "⊗", "Types"]
-v1 = filter((x) -> eval(Semirings, :(typeof($x) <: AbstractSemiring)), names(Semirings))
-v2 = []
-v3 = []
-for rig in v1
-    rig = string(rig)
-    rigsplit = split(rig, '_')
-    monoidname = rigsplit[1] .* "_MONOID"
-    push!(v2, "[" .* rigsplit[1] .* "_MONOID](https://juliasparse.github.io/SuiteSparseGraphBLAS.jl/dev/monoids/#SuiteSparseGraphBLAS.Monoids.$monoidname)")
-    push!(v3, "[" .* rigsplit[2] .* "](https://juliasparse.github.io/SuiteSparseGraphBLAS.jl/dev/binaryops/#SuiteSparseGraphBLAS.BinaryOps.$(rigsplit[2]))")
+v1 = filter((x) -> getproperty(Semirings, x) isa SuiteSparseGraphBLAS.AbstractSemiring, names(Semirings))
+ops = getproperty.(Ref(Semirings), v1)
+v2 = convert(Vector{Any}, SuiteSparseGraphBLAS.addop.(ops))
+v3 = convert(Vector{Any}, SuiteSparseGraphBLAS.mulop.(ops))
+for i in 1:length(v2)
+    if v2[i] === nothing
+        x = 
+        v2[i] = replace(summary(SuiteSparseGraphBLAS.monoid(ops[i])), "SuiteSparseGraphBLAS.Monoids." => "")[1:end-2]
+    end
+    if v3[i] === nothing
+        v3[i] = replace(summary(SuiteSparseGraphBLAS.binop(ops[i])), "SuiteSparseGraphBLAS.BinaryOps." => "")[1:end-2]
+    end
 end
+v4 = SuiteSparseGraphBLAS.validtypes.(ops)
 
-v4 = []
-
-for op in v1
-    op == :Semirings && continue
-    op = getproperty(Semirings, op)
-    push!(v4, SuiteSparseGraphBLAS.tolist(SuiteSparseGraphBLAS.validtypes(op)))
-end
 v1 = "`" .* string.(v1) .* "`"
+v2 = "`" .* string.(v2) .* "`"
+v3 = "`" .* string.(v3) .* "`"
 Latexify.mdtable(hcat(v1,v2,v3,v4); head, latex=false)
 ```

src/operators/libgbops.jl

@@ -14,12 +14,9 @@ ytype(monoid::libgb.GrB_Monoid) = ytype(operator(monoid))
 ztype(monoid::libgb.GrB_Monoid) = ztype(operator(monoid))
 Base.show(io::IO, ::MIME"text/plain", m::libgb.GrB_Monoid) = gxbprint(io, m)
 
-
-
-
-multiplyop(rig::libgb.GrB_Semiring) = libgb.GxB_Semiring_multiply(rig)
+mulop(rig::libgb.GrB_Semiring) = libgb.GxB_Semiring_multiply(rig)
 addop(rig::libgb.GrB_Semiring) = libgb.GxB_Semiring_add(rig)
-xtype(rig::libgb.GrB_Semiring) = xtype(multiplyop(rig))
-ytype(rig::libgb.GrB_Semiring) = ytype(multiplyop(rig))
+xtype(rig::libgb.GrB_Semiring) = xtype(mulop(rig))
+ytype(rig::libgb.GrB_Semiring) = ytype(mulop(rig))
 ztype(rig::libgb.GrB_Semiring) = ztype(addop(rig))
 Base.show(io::IO, ::MIME"text/plain", s::libgb.GrB_Semiring) = gxbprint(io, s)

src/operators/oplist.jl

@@ -737,6 +737,12 @@ Monoids.BXNOR_MONOID
 op(::typeof(Monoids.BXNOR_MONOID)) = BinaryOps.BXNOR
 Monoids.Monoid(::typeof(!⊻)) = Monoids.BXNOR_MONOID
 
+mulop(rig::AbstractSemiring) = nothing
+addop(rig::AbstractSemiring) = nothing
+
+# TODO:
+# The definitions below are less than ideal, these should likely be fields of the semiring
+# structs, not evaluated functions.
 for oplus ∈ [(:max, "MAX"), (:min, "MIN"), (:+, "PLUS"), (:*, "TIMES"), (:any, "ANY")]
     for otimes ∈ [
         (:/, "DIV"),
@@ -764,13 +770,48 @@ for oplus ∈ [(:max, "MAX"), (:min, "MIN"), (:+, "PLUS"), (:*, "TIMES"), (:any,
         (:+, "PLUS"),
         (:pair, "PAIR")
     ]
-        rig = Symbol(oplus[2], "_", otimes[2])
-        funcquote = quote
-            Semirings.Semiring(::typeof($(oplus[1])), ::typeof($(otimes[1]))) = $rig
-            addop(::typeof($rig)) = $(oplus[1])
-            mulop(::typeof($rig)) = $(otimes[1])
-        end
-        @eval($funcquote)
+    rig = Symbol(oplus[2], "_", otimes[2])
+    funcquote = quote
+        Semirings.Semiring(::typeof($(oplus[1])), ::typeof($(otimes[1]))) = $rig
+        addop(::typeof($rig)) = $(oplus[1])
+        mulop(::typeof($rig)) = $(otimes[1])
+    end
+    @eval($funcquote)
+    end
+end
+
+for otimes ∈ [(:(==), "EQ"), (:(>=), "GE"), (:(>), "GT"), (:(<=), "LE"), (:(<), "LT"), (:(!=), "NE")]
+    oplus = (:any, "ANY")
+    rig = Symbol(oplus[2], "_", otimes[2])
+    funcquote = quote
+        Semirings.Semiring(::typeof($(oplus[1])), ::typeof($(otimes[1]))) = $rig
+        addop(::typeof($rig)) = $(oplus[1])
+        mulop(::typeof($rig)) = $(otimes[1])
+    end
+    @eval($funcquote)
+end
+for oplus ∈ [(:(==), "EQ"), (:∧, "LAND"), (:∨, "LOR"), (:lxor, "LXOR")]
+    for otimes ∈ [
+        (:(==), "EQ"),
+        (:(>=), "GE"),
+        (:(>), "GT"),
+        (:(<=), "LE"),
+        (:(<), "LT"),
+        (:(!=), "NE"),
+        (:first, "FIRST"),
+        (:second, "SECOND"),
+        (:∧, "LAND"),
+        (:∨, "LOR"),
+        (:lxor, "LXOR"),
+        (:pair, "PAIR")
+    ]
+    rig = Symbol(oplus[2], "_", otimes[2])
+    funcquote = quote
+        Semirings.Semiring(::typeof($(oplus[1])), ::typeof($(otimes[1]))) = $rig
+        addop(::typeof($rig)) = $(oplus[1])
+        mulop(::typeof($rig)) = $(otimes[1])
+    end
+    @eval($funcquote)
     end
 end
 

src/operators/semirings.jl

@@ -13,7 +13,6 @@ function _semiringnames(name)
     exportedname = Symbol(simple)
     return containername, exportedname
 end
-
 function Semiring(name)
     containername, exportedname = _semiringnames(name)
     structquote = quote
@@ -36,7 +35,12 @@ end
 
 SemiringUnion = Union{AbstractSemiring, TypedSemiring}
 
-
+function _monoidfromrigname(name)
+    return split(name, "_")[2] * "_MONOID"
+end
+function _binopfromrigname(name)
+    return split(name, "_")[3]
+end
 
 #TODO: Rewrite
 function _createsemirings()
@@ -255,7 +259,11 @@ function _createsemirings()
     ]
 
     for name ∈ builtins
-        Semiring(name)
+        rig = Semiring(name)
+        monoid = getproperty(Monoids, Symbol(_monoidfromrigname(name)))
+        eval(:(monoid(::typeof($rig)) = $monoid))
+        binop = getproperty(BinaryOps, Symbol(_binopfromrigname(name)))
+        eval(:(binop(::typeof($rig)) = $binop))
     end
 end