Skip to content

Commit d14824b

Browse files
author
Will Kimmerer
committed
fix monoid docs
1 parent 5c51b7d commit d14824b

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

docs/src/monoids.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,19 @@ The documentation below uses `T` to refer to any of the valid primitive types li
1616
!!! note "Note"
1717
In the case of floating point numbers +∞ and -∞ have their typical meanings. However, for integer types they indicate `typemax` and `typemin` respectively.
1818

19-
```@autodocs
20-
Modules = [SuiteSparseGraphBLAS]
21-
Pages = ["monoids.jl"]
19+
```@docs
20+
SuiteSparseGraphBLAS.Monoids.MAX_MONOID
21+
SuiteSparseGraphBLAS.Monoids.MIN_MONOID
22+
SuiteSparseGraphBLAS.Monoids.PLUS_MONOID
23+
SuiteSparseGraphBLAS.Monoids.TIMES_MONOID
24+
SuiteSparseGraphBLAS.Monoids.ANY_MONOID
25+
SuiteSparseGraphBLAS.Monoids.BAND_MONOID
26+
SuiteSparseGraphBLAS.Monoids.BOR_MONOID
27+
SuiteSparseGraphBLAS.Monoids.BXNOR_MONOID
28+
SuiteSparseGraphBLAS.Monoids.BXOR_MONOID
29+
SuiteSparseGraphBLAS.Monoids.EQ_MONOID
30+
SuiteSparseGraphBLAS.Monoids.LAND_MONOID
31+
SuiteSparseGraphBLAS.Monoids.LOR_MONOID
32+
SuiteSparseGraphBLAS.Monoids.LXNOR_MONOID
33+
SuiteSparseGraphBLAS.Monoids.LXOR_MONOID
2234
```

src/operators/operatorutils.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ _isloaded(op::Union{AbstractSelectOp, AbstractDescriptor}) = getfield(op, :p) !=
4747
validtypes(operator::SelectOp)::Nothing
4848
4949
Determine the types available as a domain for a particular operator.
50-
Each operator is defined on a specific set of types, for instance the [`LAND_LOR`](@ref)
50+
Each operator is defined on a specific set of types, for instance the [`Semirings.LAND_LOR`](@ref)
5151
semiring is only defined for `Boolean` arguments.
5252
5353
When applied to an `AbstractSelectOp` this will return `nothing`.
@@ -113,4 +113,5 @@ function Base.show(io::IO, ::MIME"text/plain", o::AbstractOp)
113113
print(io, o.name, ": ", validtypes(o))
114114
end
115115

116-
function juliaop end
116+
function juliaop end
117+
juliaop(op::AbstractMonoid) = juliaop(op(op))

0 commit comments

Comments
 (0)