Remove plotting from algorithms (#135)

* Remove plotting from algorithms

* Remove plot keyword from the docs

Author: haampie

docs/src/user_manual.md

@@ -79,22 +79,18 @@ etc.
 `log::Bool = false`: output an extra element of type `ConvergenceHistory`
 containing extra information of the method execution.
 
-`plot`: plot information relevant to the method. (Only for `Master` version)
-
 ### `log` keyword
 
 All solvers contain the `log` keyword. This is to be used when obtaining
 more information is required, to use it place the set `log` to `true`.
 
 ```julia
 x, ch = cg(Master, rand(10, 10), rand(10) log=true)
-svd, L, ch = svdl(Master, rand(100, 100), plot=true, log=true)
+svd, L, ch = svdl(Master, rand(100, 100), log=true)
 ```
 
 The function will now return one more parameter of type `ConvergenceHistory`.
 
-*`Note:`*  Keyword argument `plot` is only available when `log` is set.
-
 ## ConvergenceHistory
 
 A [`ConvergenceHistory`](@ref) instance stores information of a solver.

src/cg.jl

@@ -5,18 +5,15 @@ cg(A, b; kwargs...) = cg!(zerox(A, b), A, b; kwargs...)
 function cg!(x, A, b;
     tol = sqrt(eps(real(eltype(b)))),
     maxiter::Integer = min(20, size(A, 1)),
-    plot = false,
     log::Bool = false,
     Pl = Identity(),
     kwargs...
 )
-    (plot & !log) && error("Can't plot when log keyword is false")
     history = ConvergenceHistory(partial = !log)
     history[:tol] = tol
     log && reserve!(history, :resnorm, maxiter + 1)
     cg_method!(history, x, A, b, Pl; tol = tol, log = log, maxiter = maxiter, kwargs...)
     log && shrink!(history)
-    plot && showplot(history)
     log ? (x, history) : x
 end
 
@@ -193,7 +190,6 @@ $msg
 
 If `log` is set to `true` is given, method will output a tuple `x, ch`. Where
 `ch` is a `ConvergenceHistory` object. Otherwise it will only return `x`.
-The `plot` attribute can only be used when `log` is set version.
 
 # Arguments
 
@@ -216,8 +212,6 @@ $arg
 `log::Bool = false`: output an extra element of type `ConvergenceHistory`
 containing extra information of the method execution.
 
-`plot::Bool = false`: plot data. (Only when `log` is set)
-
 # Output
 
 **if `log` is `false`**

src/chebyshev.jl

@@ -9,18 +9,15 @@ chebyshev(A, b, λmin::Real, λmax::Real; kwargs...) =
 
 function chebyshev!(x, A, b, λmin::Real, λmax::Real;
     n::Int=size(A,2), tol::Real = sqrt(eps(typeof(real(b[1])))),
-    maxiter::Int = n^3, plot::Bool=false, log::Bool=false, kwargs...
+    maxiter::Int = n^3, log::Bool=false, kwargs...
     )
 	K = KrylovSubspace(A, n, 1, Adivtype(A, b))
 	init!(K, x)
-
-    (plot & !log) && error("Can't plot when log keyword is false")
     history = ConvergenceHistory(partial=!log)
     history[:tol] = tol
     reserve!(history,:resnorm,maxiter)
     chebyshev_method!(history, x, K, b, λmin, λmax; tol=tol, maxiter=maxiter, kwargs...)
-    (plot || log) && shrink!(history)
-    plot && showplot(history)
+    log && shrink!(history)
     log ? (x, history) : x
 end
 
@@ -101,8 +98,6 @@ $msg
 If `log` is set to `true` is given, method will output a tuple `x, ch`. Where
 `ch` is a `ConvergenceHistory` object. Otherwise it will only return `x`.
 
-The `plot` attribute can only be used when `log` is set version.
-
 # Arguments
 
 $arg
@@ -124,8 +119,6 @@ $arg
 `log::Bool = false`: output an extra element of type `ConvergenceHistory`
 containing extra information of the method execution.
 
-`plot::Bool = false`: plot data. (Only with `Master` version)
-
 # Output
 
 **if `log` is `false`**

src/gmres.jl

@@ -8,17 +8,14 @@ function gmres!(x, A, b;
   tol = sqrt(eps(real(eltype(b)))),
   restart::Int = min(20, length(b)),
   maxiter::Int = restart,
-  plot::Bool = false,
   log::Bool = false,
   kwargs...
 )
-    (plot & !log) && error("Can't plot when log keyword is false")
     history = ConvergenceHistory(partial = !log, restart = restart)
     history[:tol] = tol
     log && reserve!(history, :resnorm, maxiter)
     gmres_method!(history, x, A, b; Pl = Pl, Pr = Pr, tol = tol, maxiter = maxiter, restart = restart, log = log, kwargs...)
-    (plot || log) && shrink!(history)
-    plot && showplot(history)
+    log && shrink!(history)
     log ? (x, history) : x
 end
 

src/history.jl

@@ -265,7 +265,6 @@ plotable(::Any)::Bool = false
     showplot(ch)
 
 Print all plotable information inside `ConvergenceHistory` `ch`.
-*Note:* This is what is called when the `plot` keyword is set.
 """
 function showplot(ch::ConvergenceHistory)
     candidates = collect(values(ch.data))

src/idrs.jl

@@ -9,15 +9,13 @@ idrs(A, b; kwargs...) = idrs!(zerox(A,b), A, b; kwargs...)
 
 function idrs!(x, A, b;
     s = 8, tol=sqrt(eps(typeof(real(b[1])))), maxiter=length(x)^2,
-    plot::Bool=false, log::Bool=false, kwargs...
+    log::Bool=false, kwargs...
     )
-    (plot & !log) && error("Can't plot when log keyword is false")
     history = ConvergenceHistory(partial=!log)
     history[:tol] = tol
     reserve!(history,:resnorm, maxiter)
     idrs_method!(history, x, linsys_op, (A,), b, s, tol, maxiter; kwargs...)
-    (plot || log) && shrink!(history)
-    plot && showplot(history)
+    log && shrink!(history)
     log ? (x, history) : x
 end
 
@@ -228,8 +226,6 @@ $msg
 If `log` is set to `true` is given, method will output a tuple `x, ch`. Where
 `ch` is a `ConvergenceHistory` object. Otherwise it will only return `x`.
 
-The `plot` attribute can only be used when `log` is set version.
-
 # Arguments
 
 $arg
@@ -255,8 +251,6 @@ $arg
 `log::Bool = false`: output an extra element of type `ConvergenceHistory`
 containing extra information of the method execution.
 
-`plot::Bool = false`: plot data. (Only when `log` is set)
-
 # Output
 
 **if `log` is `false`**

src/lanczos.jl

@@ -7,16 +7,14 @@ export eiglancz
 ####################
 
 function eiglancz(A;
-    maxiter::Integer=size(A,1), plot::Bool=false,
+    maxiter::Integer=size(A,1),
     tol::Real = size(A,1)^3*eps(real(eltype(A))), log::Bool=false, kwargs...
     )
-    (plot & !log) && error("Can't plot when log keyword is false")
     history = ConvergenceHistory(partial=!log)
     history[:tol] = tol
     reserve!(history,:resnorm, maxiter)
     e1 = eiglancz_method(history, A; maxiter=maxiter, tol=tol, kwargs...)
-    (plot || log) && shrink!(history)
-    plot && showplot(history)
+    log && shrink!(history)
     log ? (e1, history) : e1
 end
 
@@ -89,8 +87,6 @@ $msg
 If `log` is set to `true` is given, method will output a tuple `eigs, ch`. Where
 `ch` is a `ConvergenceHistory` object. Otherwise it will only return `eigs`.
 
-The `plot` attribute can only be used when `log` is set version.
-
 # Arguments
 
 $arg
@@ -110,8 +106,6 @@ $arg
 `log::Bool = false`: output an extra element of type `ConvergenceHistory`
 containing extra information of the method execution.
 
-`plot::Bool = false`: plot data. (Only when `log` is set)
-
 # Output
 
 **if `log` is `false`**

src/lsmr.jl

@@ -9,10 +9,9 @@ using Base.LinAlg
 lsmr(A, b; kwargs...) = lsmr!(zerox(A, b), A, b; kwargs...)
 
 function lsmr!(x, A, b;
-    plot::Bool=false, maxiter::Integer = max(size(A,1), size(A,2)),
+    maxiter::Integer = max(size(A,1), size(A,2)),
     log::Bool=false, kwargs...
     )
-    (plot & !log) && error("Can't plot when log keyword is false")
     history = ConvergenceHistory(partial=!log)
     reserve!(history,[:anorm,:rnorm,:cnorm],maxiter)
 
@@ -22,8 +21,7 @@ function lsmr!(x, A, b;
     copy!(btmp, b)
     v, h, hbar = similar(x, T), similar(x, T), similar(x, T)
     lsmr_method!(history, x, A, btmp, v, h, hbar; maxiter=maxiter, kwargs...)
-    (plot || log) && shrink!(history)
-    plot && showplot(history)
+    log && shrink!(history)
     log ? (x, history) : x
 end
 
@@ -273,8 +271,6 @@ but has better numerical properties, especially if A is ill-conditioned.
 If `log` is set to `true` is given, method will output a tuple `x, ch`. Where
 `ch` is a `ConvergenceHistory` object. Otherwise it will only return `x`.
 
-The `plot` attribute can only be used when `log` is set version.
-
 # Arguments
 
 $arg
@@ -307,8 +303,6 @@ may then be excessive.
 `log::Bool = false`: output an extra element of type `ConvergenceHistory`
 containing extra information of the method execution.
 
-`plot::Bool = false`: plot data. (Only when `log` is set)
-
 # Output
 
 **if `log` is `false`**

src/lsqr.jl

@@ -7,18 +7,15 @@ export lsqr, lsqr!
 lsqr(A, b; kwargs...) = lsqr!(zerox(A, b), A, b; kwargs...)
 
 function lsqr!(x, A, b;
-    plot::Bool=false, maxiter::Int=max(size(A,1), size(A,2)), log::Bool=false,
+    maxiter::Int=max(size(A,1), size(A,2)), log::Bool=false,
     kwargs...
     )
     T = Adivtype(A, b)
     z = zero(T)
-
-    (plot & !log) && error("Can't plot when log keyword is false")
     history = ConvergenceHistory(partial=!log)
     reserve!(history,[:resnorm,:anorm,:rnorm,:cnorm],maxiter)
     lsqr_method!(history, x, A, b; maxiter=maxiter, kwargs...)
-    (plot || log) && shrink!(history)
-    plot && showplot(history)
+    log && shrink!(history)
     log ? (x, history) : x
 end
 
@@ -262,8 +259,6 @@ but has better numerical properties, especially if A is ill-conditioned.
 If `log` is set to `true` is given, method will output a tuple `x, ch`. Where
 `ch` is a `ConvergenceHistory` object. Otherwise it will only return `x`.
 
-The `plot` attribute can only be used when `log` is set version.
-
 # Arguments
 
 $arg
@@ -296,8 +291,6 @@ may then be excessive.
 `log::Bool = false`: output an extra element of type `ConvergenceHistory`
 containing extra information of the method execution.
 
-`plot::Bool = false`: plot data. (Only when `log` is set)
-
 # Output
 
 **if `log` is `false`**

src/simple.jl

@@ -7,18 +7,16 @@ export powm, invpowm
 
 function powm(A;
     x=nothing, tol::Real=eps(real(eltype(A)))*size(A,2)^3, maxiter::Int=size(A,2),
-    plot::Bool=false, log::Bool=false, kwargs...
+    log::Bool=false, kwargs...
     )
     K = KrylovSubspace(A, 1)
     x==nothing ? initrand!(K) : init!(K, x/norm(x))
 
-    (plot & !log) && error("Can't plot when log keyword is false")
     history = ConvergenceHistory(partial=!log)
     history[:tol] = tol
     reserve!(history,:resnorm, maxiter)
     eig, v = powm_method!(history, K; tol=tol, maxiter=maxiter, kwargs...)
-    (plot || log) && shrink!(history)
-    plot && showplot(history)
+    log && shrink!(history)
     log ? (eig, v, history) : (eig, v)
 end
 
@@ -53,18 +51,16 @@ end
 
 function invpowm(A;
     x=nothing, shift::Number=0, tol::Real=eps(real(eltype(A)))*size(A,2)^3,
-    maxiter::Int=size(A,2), plot::Bool=false, log::Bool=false, kwargs...
+    maxiter::Int=size(A,2), log::Bool=false, kwargs...
     )
     K = KrylovSubspace(A, 1)
     x==nothing ? initrand!(K) : init!(K, x/norm(x))
 
-    (plot & !log) && error("Can't plot when log keyword is false")
     history = ConvergenceHistory(partial=!log)
     history[:tol] = tol
     reserve!(history,:resnorm, maxiter)
     eig, v = invpowm_method!(history, K, shift; tol=tol, maxiter=maxiter, kwargs...)
-    (plot || log) && shrink!(history)
-    plot && showplot(history)
+    log && shrink!(history)
     log ? (eig, v, history) : (eig, v)
 end
 
@@ -131,8 +127,6 @@ $msg
 If `log` is set to `true` is given, method will output a tuple `eig, v, ch`. Where
 `ch` is a `ConvergenceHistory` object. Otherwise it will only return `eig, v`.
 
-The `plot` attribute can only be used when `log` is set version.
-
 # Arguments
 
 `K::KrylovSubspace`: krylov subspace.
@@ -154,8 +148,6 @@ $karg
 `log::Bool = false`: output an extra element of type `ConvergenceHistory`
 containing extra information of the method execution.
 
-`plot::Bool = false`: plot data. (Only when `log` is set)
-
 # Output
 
 **if `log` is `false`**