Merge pull request #174 from haampie/remove-plots

Remove dependencies on UnicodePlots and LinearMaps

Author: haampie

REQUIRE

@@ -1,6 +1,4 @@
 julia 0.6
 
-UnicodePlots
 RecipesBase
 SugarBLAS
-LinearMaps

docs/src/about/CONTRIBUTING.md

@@ -42,10 +42,7 @@ other git branches will let you use/test whatever there is.
 
 ## Adding or modifying iterative methods
 
-Each iterative method method must log information using the inner `ConvergenceHistory`
-type. When information is not necessary to be stored (plot is set to `false`) then
-instead of `ConvergenceHistory` create a `DummyHistory`, this type has the same
-calls `ConvergenceHistory` does but without storing anything.
+Each iterative method method must log information using the inner `ConvergenceHistory` type.
 
 There are two types of `ConvergenceHistory`: plain and restarted. The only real
 difference between the two is how they are plotted and how the number of restarts

src/common.jl

@@ -1,7 +1,5 @@
 import Base: A_ldiv_B!, \
 
-using LinearMaps
-
 export Identity
 
 #### Type-handling

src/history.jl

@@ -1,10 +1,10 @@
-import  Base: getindex, setindex!, push!, keys
+using RecipesBase
+
+import Base: getindex, setindex!, push!, keys
 
 export ConvergenceHistory
 export nprods, niters, nrests
 
-using UnicodePlots
-
 ########
 # Type #
 ########
@@ -259,71 +259,6 @@ such objects.
 plotable(::VecOrMat{T}) where {T <: Real} = true
 plotable(::Any) = false
 
-# inner plots
-
-"""
-    showplot(ch)
-
-Print all plotable information inside `ConvergenceHistory` `ch`.
-"""
-function showplot(ch::ConvergenceHistory)
-    candidates = collect(values(ch.data))
-    plotables = convert(Vector{Bool},map(plotable, candidates))
-    n = length(filter(identity, plotables))
-    n > 0 || return
-    println("\n")
-    for (name, draw) in collect(ch.data)[plotables]
-        restart = isa(ch, UnrestartedHistory) ? ch.iters : ch.restart
-        drawing = plot_collection(draw, ch.iters, restart; name=string(name))
-        println("$drawing\n\n")
-    end
-end
-
-"""
-    plot_collection(x)
-
-Build a `UnicodePlot.Plot` object from the plotable collection `x`.
-If `x` is a vector, a series will be made. In case of being a matrix an scatterplot
-will be returned.
-"""
-function plot_collection(vals::Vector{T}, iters::Int, gap::Int;
-    restarts=Int(ceil(iters/gap)), color::Symbol=:blue, name::AbstractString="",
-    title::AbstractString="", left::Int=1
-    ) where {T <: Real}
-    maxy = round(maximum(vals),2)
-    miny = round(minimum(vals),2)
-    plot = lineplot([left],[miny],xlim=[left,iters],ylim=[miny,maxy],title=title,name=name)
-    right = min(left+gap-1,iters)
-    lineplot!(plot,collect(left:right),vals[left:right],color=color)
-    for restart in 2:restarts
-        left+=gap
-        right = min(left+gap-1,iters)
-        lineplot!(plot,collect(left:right),vals[left:right],color=color)
-        lineplot!(plot,[left,left],[miny,maxy], color=:white)
-    end
-    plot
-end
-function plot_collection(vals::Matrix{T}, iters::Int, gap::Int;
-    restarts=Int(ceil(iters/gap)), color::Symbol=:blue, name::AbstractString="",
-    title::AbstractString="", left::Int=1
-    ) where {T <: Real}
-    n = size(vals,2)
-    maxy = round(maximum(vals),2)
-    miny = round(minimum(vals),2)
-    plot = scatterplot([left],[miny],xlim=[left,iters],ylim=[miny,maxy],title=title,name=name)
-    for i in left:iters
-        scatterplot!(plot,[i for j in 1:n],vec(vals[i,1:n]),color=color)
-    end
-    for restart in 2:restarts
-        left+=gap
-        lineplot!(plot,[left,left],[miny,maxy], color=:white)
-    end
-    plot
-end
-
-## Recipes (See Plots.jl tutorial on recipes)
-
-using RecipesBase
 
 # Plot entire ConvergenceHistory. `sep` is the color of the restart separator.
 @recipe function chef(ch::CompleteHistory; sep = :white)

test/REQUIRE

@@ -1,3 +1 @@
-Plots
-UnicodePlots
 LinearMaps

test/history.jl

@@ -1,24 +1,68 @@
 using IterativeSolvers
-using Plots
+using RecipesBase
+using Base.Test
 
-#Just check it doesn't crash
 @testset "ConvergenceHistory" begin
 
-srand(1234321)
+    const KW = Dict{Symbol, Any}
 
-#Use UnicodePlots backend because it is the lightest
-unicodeplots()
+    RecipesBase.is_key_supported(k::Symbol) = k == :sep ? false : true
 
-A = lu(rand(10, 10))[1]
-b = rand(10)
+    # No plottables
+    begin
+        history = ConvergenceHistory(partial = false)
+        @test_throws ErrorException RecipesBase.apply_recipe(KW(), history)
+    end
 
-for solver in (cg, gmres, minres, lsqr, lsmr, idrs)
-    plot(solver(A, b; log=true)[2])
-end
+    # Without restart markers
+    begin
+        history = ConvergenceHistory(partial = false)
+        history.iters = 3
+        history.data[:resnorm] = [10.0, 3.0, 0.1]
+        
+        plots = (
+            RecipesBase.apply_recipe(KW(), history),
+            RecipesBase.apply_recipe(KW(), history, :resnorm)
+        )
+
+        for data in plots
+            @test length(data) == 1
+            @test data[1].d[:label] == "resnorm"
+            @test data[1].d[:seriestype] == :line
+        end
+    end
+
+    # With restart markers
+    begin
+        history = ConvergenceHistory(partial = false, restart = 2)
+        history.iters = 3
+        history.data[:resnorm] = [10.0, 3.0, 0.1]
+
+        plots = (
+            RecipesBase.apply_recipe(KW(), history),
+            RecipesBase.apply_recipe(KW(), history, :resnorm)
+        )
+
+        for data in plots
+            @test length(data) == 2
+            @test data[2].d[:linecolor] == :white    
+        end
+    end
+
+    # Custom color
+    begin
+        history = ConvergenceHistory(partial = false, restart = 2)
+        history.iters = 3
+        history.data[:resnorm] = [10.0, 3.0, 0.1]
+
+        plots = (
+            RecipesBase.apply_recipe(KW(:sep => :red), history),
+            RecipesBase.apply_recipe(KW(:sep => :red), history, :resnorm)
+        )
 
-plot(bicgstabl(A, b, 2, log=true)[2])
-plot(chebyshev(A, b, 0.5, 1.5; log=true)[2])
-plot(powm(A; log=true)[2])
-plot(invpowm(A; log=true)[2])
-plot(svdl(A; log=true)[3])
+        for data in plots
+            @test length(data) == 2
+            @test data[2].d[:linecolor] == :red
+        end
+    end
 end