Add BlockDiagonalOperator and TimedLinearOperator in the documentation

README.md

@@ -38,6 +38,7 @@ Operator               | Description
 `LinearOperator`       | Base class. Useful to define operators from functions
 `PreallocatedLinearOperator` | Linear operator with preallocated storage for products
 `TimedLinearOperator`  | Linear operator instrumented with timers from [`TimerOutputs`](https://github.com/KristofferC/TimerOutputs.jl)
+`BlockDiagonalOperator`| Block-diagonal linear operator
 `opEye`                | Identity operator
 `opOnes`               | All ones operator
 `opZeros`              | All zeros operator

docs/make.jl

@@ -1,20 +1,15 @@
-using Documenter
-using LinearOperators
+using Documenter, LinearOperators
 
 makedocs(
   modules = [LinearOperators],
   doctest = true,
+  # linkcheck = true,
   strict = true,
-  assets = ["assets/style.css"],
-  format = Documenter.HTML(),
+  format = Documenter.HTML(assets = ["assets/style.css"], prettyurls = get(ENV, "CI", nothing) == "true"),
   sitename = "LinearOperators.jl",
   pages = Any["Home" => "index.md",
               "Tutorial" => "tutorial.md",
               "Reference" => "reference.md"]
 )
 
-deploydocs(deps = nothing, make = nothing,
-  repo = "github.com/JuliaSmoothOptimizers/LinearOperators.jl.git",
-  target = "build",
-  devbranch = "master"
-)
+deploydocs(repo = "github.com/JuliaSmoothOptimizers/LinearOperators.jl.git")

docs/src/index.md

@@ -21,6 +21,8 @@ Operator                     | Description
 -----------------------------|------------
 `LinearOperator`             | Base class. Useful to define operators from functions
 `PreallocatedLinearOperator` | Define operators with preallocation for efficient use of memory
+`TimedLinearOperator`        | Linear operator instrumented with timers from [`TimerOutputs`](https://github.com/KristofferC/TimerOutputs.jl)
+`BlockDiagonalOperator`      | Block-diagonal linear operator
 `opEye`                      | Identity operator
 `opOnes`                     | All ones operator
 `opZeros`                    | All zeros operator

docs/src/reference.md

@@ -3,6 +3,8 @@
 ```@docs
 LinearOperator
 PreallocatedLinearOperator
+TimedLinearOperator
+BlockDiagonalOperator
 opEye
 opOnes
 opZeros

src/TimedOperators.jl

@@ -10,6 +10,11 @@ mutable struct TimedLinearOperator{T} <: AbstractLinearOperator{T}
   ctprod
 end
 
+"""
+    TimedLinearOperator(op)
+
+Creates a linear operator instrumented with timers from TimerOutputs.
+"""
 function TimedLinearOperator(op::AbstractLinearOperator{T}) where T
   timer = TimerOutput()
   prod(x) = @timeit timer "prod" op.prod(x)

src/special-operators.jl

@@ -186,6 +186,16 @@ end
 
 eltypeof(op::AbstractLinearOperator) = eltype(op)  # need this for promote_eltypeof
 
+"""
+    BlockDiagonalOperator(M1, M2, ..., Mn)
+
+Creates a block-diagonal linear operator:
+
+    [ M1           ]
+    [    M2        ]
+    [       ...    ]
+    [           Mn ]
+"""
 function BlockDiagonalOperator(ops...)
   nrow = ncol = 0
   for op ∈ ops