Add :logbins to settings

Author: timholy

docs/src/manual.md

@@ -901,33 +901,37 @@ For comparing two or more benchmarks against one another, you can manually speci
 `IOContext` to set `:histmin` and `:histmax`:
 
 ```julia
-julia> io = IOContext(stdout, :histmin=>0.5, :histmax=>8)
+julia> io = IOContext(stdout, :histmin=>0.5, :histmax=>8, :logbins=>true)
 IOContext(Base.TTY(RawFD(13) open, 0 bytes waiting))
 
-julia> b = @benchmark x^3 setup=(x = rand()); show(io, MIME("text/plain"), b)
+julia> b = @benchmark x^3   setup=(x = rand()); show(io, MIME("text/plain"), b)
 BenchmarkTools.Trial: 10000 samples with 1000 evaluations.
- Range (min … max):  1.239 ns … 28.036 ns  ┊ GC (min … max): 0.00% … 0.00%
- Time  (median):     1.258 ns              ┊ GC (median):    0.00%
- Time  (mean ± σ):   1.277 ns ±  0.593 ns  ┊ GC (mean ± σ):  0.00% ± 0.00%
+ Range (min … max):  1.239 ns … 31.433 ns  ┊ GC (min … max): 0.00% … 0.00%
+ Time  (median):     1.244 ns              ┊ GC (median):    0.00%
+ Time  (mean ± σ):   1.266 ns ±  0.611 ns  ┊ GC (mean ± σ):  0.00% ± 0.00%
 
-       █▁                                                    ▁
-  ▁▁▁▁▁██▆▄▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ █
+       █
+  ▁▁▁▁▁█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ ▂
   0.5 ns       Histogram: log(frequency) by time        8 ns <
 
  Memory estimate: 0 bytes, allocs estimate: 0.
 julia> b = @benchmark x^3.0 setup=(x = rand()); show(io, MIME("text/plain"), b)
 BenchmarkTools.Trial: 10000 samples with 1000 evaluations.
- Range (min … max):  5.399 ns … 35.552 ns  ┊ GC (min … max): 0.00% … 0.00%
- Time  (median):     5.422 ns              ┊ GC (median):    0.00%
- Time  (mean ± σ):   5.510 ns ±  1.291 ns  ┊ GC (mean ± σ):  0.00% ± 0.00%
+ Range (min … max):  5.636 ns … 38.756 ns  ┊ GC (min … max): 0.00% … 0.00%
+ Time  (median):     5.662 ns              ┊ GC (median):    0.00%
+ Time  (mean ± σ):   5.767 ns ±  1.384 ns  ┊ GC (mean ± σ):  0.00% ± 0.00%
 
-                                        █
-  ▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▅█▂▂▂▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁ ▂
-  0.5 ns         Histogram: frequency by time           8 ns <
+                                         █▆    ▂             ▁
+  ▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁███▄▄▃█▁▁▁▁▁▁▁▁▁▁▁▁ █
+  0.5 ns       Histogram: log(frequency) by time        8 ns <
 
  Memory estimate: 0 bytes, allocs estimate: 0.
+
 ```
 
+Set `:logbins` to `true` or `false` to ensure that all use the same vertical scaling (log frequency or frequency).
+
+
 The `Trial` object can be visualized using the `BenchmarkPlots` package:
 
 ```julia

src/trials.jl

@@ -442,11 +442,14 @@ function Base.show(io::IO, ::MIME"text/plain", t::Trial)
     histtimes = times[1:round(Int, histquantile*end)]
     histmin = get(io, :histmin, first(histtimes))
     histmax = get(io, :histmax, last(histtimes))
-    bins, logbins = bindata(histtimes, histwidth - 1, histmin, histmax), false
+    logbins = get(io, :logbins, nothing)
+    bins = bindata(histtimes, histwidth - 1, histmin, histmax)
     append!(bins, [1, floor((1-histquantile) * length(times))])
     # if median size of (bins with >10% average data/bin) is less than 5% of max bin size, log the bin sizes
-    if median(filter(b -> b > 0.1 * length(times) / histwidth, bins)) / maximum(bins) < 0.05
+    if (logbins === nothing || logbins === true) && median(filter(b -> b > 0.1 * length(times) / histwidth, bins)) / maximum(bins) < 0.05
         bins, logbins = log.(1 .+ bins), true
+    elseif logbins === nothing
+        logbins = false
     end
     hist = asciihist(bins, histheight)
     hist[:,end-1] .= ' '

test/ExecutionTests.jl

@@ -136,7 +136,7 @@ tune!(b)
 @benchmark(output=sin(x), setup=(x=1.0; output=0.0), teardown=(@test output == sin(x)))
 
 io = IOBuffer()
-ioctx = IOContext(io, :histmin=>0.5, :histmax=>8)
+ioctx = IOContext(io, :histmin=>0.5, :histmax=>8, :logbins=>false)
 b = @benchmark x^3   setup=(x = rand()); show(ioctx, MIME("text/plain"), b)
 b = @benchmark x^3.0 setup=(x = rand()); show(ioctx, MIME("text/plain"), b)
 str = String(take!(io))