docs

Author: Wimmerer

Project.toml

@@ -9,6 +9,7 @@ ChainRules = "082447d4-558c-5d27-93f4-14fc19e9eca2"
 ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
 ChainRulesTestUtils = "cdddcdb0-9152-4a09-a978-84456f9df70a"
 ContextVariablesX = "6add18c4-b38d-439d-96f6-d6bc489c04c5"
+Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
 Libdl = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"

docs/Project.toml

@@ -1,3 +1,4 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
 SuiteSparseGraphBLAS = "c2e53296-7b14-11e9-1210-bddfa8111e1d"

docs/make.jl

@@ -1,6 +1,6 @@
 using Documenter
 using SuiteSparseGraphBLAS
-
+using LinearAlgebra
 makedocs(
     modules = [SuiteSparseGraphBLAS],
     sitename="SuiteSparseGraphBLAS.jl",
@@ -12,7 +12,8 @@ makedocs(
             "unaryops.md",
             "binaryops.md",
             "monoids.md",
-            "semirings.md"
+            "semirings.md",
+            "selectops.md"
         ]
     ]
 )

docs/src/binaryops.md

@@ -0,0 +1,8 @@
+# Binary Operators
+
+## Built-Ins
+
+```@autodocs
+Modules = [SuiteSparseGraphBLAS]
+Pages   = ["binaryops.jl"]
+```

docs/src/index.md

@@ -192,7 +192,7 @@ BOR       COPYSIGN   FIRSTJ     ISEQ       LAND       MAX        POW        SECO
 
 ## Example
 
-Here is an example of several different methods of triangle counting with GraphBLAS.
+Here is an example of two different methods of triangle counting with GraphBLAS.
 The methods are drawn from the LAGraph [repo](https://github.com/GraphBLAS/LAGraph).
 
 Input `A` must be a square, symmetric matrix with any element type.

docs/src/monoids.md

@@ -0,0 +1,16 @@
+# Monoids
+## About
+
+A monoid is made up of a set or domain $T$ and a binary operator $z = f(x, y)$ operating on the same domain, $T \times T \rightarrow T$.
+This binary operator must be associative, that is $f(a, f(b, c)) = f(f(a, b), c)$ is always true. Associativity is important for operations like `reduce` and the multiplication step of `mul`.
+
+The operator must also be equipped with an identity such that $f(x, 0) = f(0, x) = x$. Some monoids are equipped with a terminal or annihilator such that $z = f(z, x) \forall x$.
+
+## Built-Ins
+!!! note "Note"
+    In the case of floating point numbers +∞ and -∞ have their typical meanings. However, for integer types they indicate `typemax` and `typemin` respectively.
+
+```@autodocs
+Modules = [SuiteSparseGraphBLAS]
+Pages   = ["monoids.jl"]
+```

docs/src/operations.md

@@ -46,9 +46,9 @@ extract
 extract!
 subassign!
 assign!
-map
+Base.map(::SuiteSparseGraphBLAS.AbstractOp, ::SuiteSparseGraphBLAS.GBArray, ::Any)
 select
-reduce
+Base.reduce
 gbtranspose
-kron
+LinearAlgebra.kron
 ```

docs/src/selectops.md

@@ -0,0 +1,9 @@
+# Select Operators
+## About
+
+## Built-Ins
+
+```@autodocs
+Modules = [SuiteSparseGraphBLAS]
+Pages   = ["selectops.jl"]
+```

docs/src/semirings.md

@@ -0,0 +1,25 @@
+# Semirings
+## About
+
+A semiring in GraphBLAS is a domain $T$ along with two binary operators. The first, $\oplus$ or "add" is a commutative and associative monoid. The second, $\otimes$ or "multiply", is a binary operator `z = f(x, y)` such that the monoid type matches the type of `z`.
+
+## Built-Ins
+```@eval
+using Pkg
+Pkg.activate("..")
+cd("..")
+using SuiteSparseGraphBLAS
+using Latexify
+head = ["Semiring", "⊕", "⊗", "Types"]
+v1 = filter((x) -> x != "Semirings", string.(names(Semirings)))
+v2 = "[" .* getindex.(split.(v1, '_'),1) .* "_MONOID](@ref)"
+v3 = "[" .* getindex.(split.(v1, '_'), 2) .* "](@ref)"
+v4 = []
+v1 = "`" .* v1 .* "`"
+for op in names(Semirings)
+    op == :Semirings && continue
+    op = getproperty(Semirings, op)
+    push!(v4, SuiteSparseGraphBLAS.validtypes(op))
+end
+Latexify.mdtable(hcat(v1,v2,v3,v4); head, latex=false)
+```

docs/src/unaryops.md

@@ -1,5 +1,7 @@
 # Unary Operators
 
+## Built-Ins
+
 ```@autodocs
 Modules = [SuiteSparseGraphBLAS]
 Pages   = ["unaryops.jl"]