docs, rem iterator file

Author: Will Kimmerer

docs/src/arrays.md

@@ -11,7 +11,7 @@ AbstractGBArray{T, N, F} <: AbstractSparseArray{T, N}
      └─ GBVector{T, F}
 ```
 
-The `T` parameter is the element type of the array, `N` is the dimensionality, `F` is the type of the fill value (often `Nothing` or `T`). The [`OrientedGBMatrix`](@ref) restricts the orientation to the parameter `O` which is either `ByRow()` or `ByCol()`. 
+The `T` parameter is the element type of the array, `N` is the dimensionality, `F` is the type of the fill value (often `Nothing` or `T`). The `OrientedGBMatrix` restricts the orientation to the parameter `O` which is either `ByRow()` or `ByCol()`. 
 
 All of these types attempt to implement most of the `AbstractArray` interface, and the relevant parts of the `SparseArrays` interface.
 

docs/src/index.md

@@ -152,7 +152,7 @@ Unfortunately this has a couple problems. The first is that it's slow.\
 Compared to `A .+ 1` which lowers to `apply(+, A, 1)` the `map` call above is ~2.5x slower due to function pointer overhead.
 
 The second is that everytime we call `map(increment, M)` we will be re-creating the function pointer for `increment` matched to the type of `M`.\
-To avoid this there's a convenience macro [`@unop`](@ref) which will provide a permanent constant which is used every time `increment` is called with a GraphBLAS operation. See [Operators](@ref) for more information.
+To avoid this the convenience macro `@unop` will provide a permanent constant which is used internally every time `increment` is called with a GraphBLAS operation. See [Operators](@ref) for more information.
 
 !!! warning "Performance of User Defined Functions"
     Operators which are not already built-in are automatically constructed using function pointers when called. 

docs/src/operators.md

@@ -1,4 +1,4 @@
-# Basics
+# Operators
 
 Operators are one of the basic objects of GraphBLAS. In Julia, however, users must only interact directly with operators on rare occasions, and should instead pass functions to GraphBLAS operations.
 

docs/src/utilities.md

@@ -0,0 +1,10 @@
+```@docs
+setfill
+setfill!
+mask
+mask!
+gbset
+Descriptor
+SuiteSparseGraphBLAS.set_lib!
+clear!
+```

src/SuiteSparseGraphBLAS.jl

@@ -96,9 +96,8 @@ include("serialization.jl")
 #EXPERIMENTAL
 include("misc.jl")
 include("asjulia.jl")
-# include("spmgb/sparsemat.jl")
 include("mmread.jl")
-include("iterator.jl")
+# include("iterator.jl")
 include("oriented.jl")
 
 export SparseArrayCompat

src/abstractgbarray.jl

@@ -516,10 +516,22 @@ function Base.getindex(
     return extract(A, i, j; mask, accum, desc)
 end
 
+"""
+    setfill!(A::AbstractGBArray{T, N, F}, x::F)
+
+Modify the fill value of `A`. 
+The fill type of `A` and the type of `x` must be the same.
+"""
 function setfill!(A::AbstractGBArray, x)
     A.fill = x
 end
 
+"""
+    setfill(A::AbstractGBArray{T, N, F}, x::F2)
+
+Create a new AbstractGBArray with the same underlying data but a new fill `x`.
+The fill type of `A` and the type of `x` may be different.
+"""
 function setfill(A::AbstractGBArray, x) # aliasing form.
     B = similar(A; fill=x)
     B.p = A.p

src/operations/map.jl

@@ -123,7 +123,6 @@ Base.:-(u::GBArray) = apply(-, u)
     mask!(C::GBArray, A::GBArray, mask::GBArray)
 
 Apply a mask to matrix `A`, storing the results in C.
-
 """
 function mask!(C::GBArray, A::GBArray, mask::GBArray; structural = false, complement = false)
     desc = Descriptor()

src/options.jl

@@ -3,7 +3,7 @@
     gbset(option, value)
 
 Set an option either for a specific GBArray, or globally. The commonly used options are:
-    - `:format = [:byrow | :bycol]`: The global default or array specific
+    - `:format = [RowMajor() | ColMajor()]`: The global default or array specific
     column major or row major ordering.
     - `:nthreads = [Integer]`: The global number of OpenMP threads to use.
     - `:burble = [Bool]`: Print diagnostic output.