Merge pull request #182 from haampie/feature-friendly-convergence-history

Make convergence history show a summary

Author: haampie

src/history.jl

@@ -1,6 +1,6 @@
 using RecipesBase
 
-import Base: getindex, setindex!, push!, keys
+import Base: getindex, setindex!, push!, keys, show
 
 export ConvergenceHistory
 export nprods, niters, nrests
@@ -90,6 +90,11 @@ const RestartedHistory{T} = ConvergenceHistory{T, Int}
 # Functions #
 #############
 
+function show(io::IO, ch::ConvergenceHistory)
+    print(io, ch.isconverged ? "Converged" : "Not converged",
+        " after ", ch.iters, " iterations.")
+end
+
 """
     getindex(ch, s)
 

test/history.jl

@@ -8,6 +8,15 @@ using Base.Test
 
     RecipesBase.is_key_supported(k::Symbol) = k == :sep ? false : true
 
+    begin
+        history = ConvergenceHistory(partial = false)
+        history.iters = 3
+        history.isconverged = true
+        @test string(history) == "Converged after 3 iterations."
+        history.isconverged = false
+        @test string(history) == "Not converged after 3 iterations."
+    end
+
     # No plottables
     begin
         history = ConvergenceHistory(partial = false)