Make TrialContents a struct and use it in tests

Author: Zentrik

src/execution.jl

@@ -108,7 +108,7 @@ function _run(b::Benchmark, p::Parameters; verbose=false, pad="", kwargs...)
     params.gcsample && gcscrub()
     trial_contents = b.samplefunc(b.quote_vals, params)
     push!(trial, trial_contents)
-    return_val = trial_contents.__return_val
+    return_val = trial_contents.return_val
     iters = 2
     while (Base.time() - start_time) < params.seconds && iters ≤ params.samples
         params.gcsample && gcscrub()
@@ -178,7 +178,7 @@ function _lineartrial(b::Benchmark, p::Parameters=b.params; maxevals=RESOLUTION,
     for evals in eachindex(estimates)
         params.gcsample && gcscrub()
         params.evals = evals
-        estimates[evals] = first(b.samplefunc(b.quote_vals, params))
+        estimates[evals] = b.samplefunc(b.quote_vals, params).time
         completed += 1
         ((time() - start_time) > params.seconds) && break
     end
@@ -596,7 +596,7 @@ function generate_benchmark_definition(
                         )
                     end
                 end
-                return (;
+                return BenchmarkTools.TrialContents(
                     __time,
                     __gctime,
                     __memory,

src/trials.jl

@@ -11,6 +11,16 @@ mutable struct Trial
     linux_perf_stats::Union{LinuxPerf.Stats,Nothing}
 end
 
+struct TrialContents
+    time
+    gctime
+    memory
+    allocs
+    return_val
+    return_val_2
+    linux_perf_stats
+end
+
 function Trial(params::Parameters)
     return Trial(params, Float64[], Float64[], typemax(Int), typemax(Int), nothing)
 end
@@ -27,26 +37,16 @@ function Base.copy(t::Trial)
     return Trial(copy(t.params), copy(t.times), copy(t.gctimes), t.memory, t.allocs)
 end
 
-const TrialContents = NamedTuple{(
-    :__time,
-    :__gctime,
-    :__memory,
-    :__allocs,
-    :__return_val,
-    :__return_val_2,
-    :__linux_perf_stats,
-)}
-
 function Base.push!(t::Trial, trial_contents::TrialContents)
-    time = trial_contents.__time
-    gctime = trial_contents.__gctime
-    memory = trial_contents.__memory
-    allocs = trial_contents.__allocs
+    time = trial_contents.time
+    gctime = trial_contents.gctime
+    memory = trial_contents.memory
+    allocs = trial_contents.allocs
     push!(t.times, time)
     push!(t.gctimes, gctime)
     memory < t.memory && (t.memory = memory)
     allocs < t.allocs && (t.allocs = allocs)
-    t.linux_perf_stats = trial_contents.__linux_perf_stats
+    t.linux_perf_stats = trial_contents.linux_perf_stats
     return t
 end
 
@@ -58,7 +58,12 @@ end
 
 Base.length(t::Trial) = length(t.times)
 function Base.getindex(t::Trial, i::Number)
-    return push!(Trial(t.params), t.times[i], t.gctimes[i], t.memory, t.allocs)
+    return push!(
+        Trial(t.params),
+        TrialContents(
+            t.times[i], t.gctimes[i], t.memory, t.allocs, nothing, nothing, nothing
+        ),
+    )
 end
 Base.getindex(t::Trial, i) = Trial(t.params, t.times[i], t.gctimes[i], t.memory, t.allocs)
 Base.lastindex(t::Trial) = length(t)

test/TrialsTests.jl

@@ -6,16 +6,15 @@ using Test
 #########
 # Trial #
 #########
-
 trial1 = BenchmarkTools.Trial(BenchmarkTools.Parameters(; evals=2))
-push!(trial1, 2, 1, 4, 5)
-push!(trial1, 21, 0, 41, 51)
+push!(trial1, TrialContents(2, 1, 4, 5, nothing, nothing, nothing))
+push!(trial1, TrialContents(21, 0, 41, 51, nothing, nothing, nothing))
 
 trial2 = BenchmarkTools.Trial(BenchmarkTools.Parameters(; time_tolerance=0.15))
-push!(trial2, 21, 0, 41, 51)
-push!(trial2, 2, 1, 4, 5)
+push!(trial2, TrialContents(21, 0, 41, 51, nothing, nothing, nothing))
+push!(trial2, TrialContents(2, 1, 4, 5, nothing, nothing, nothing))
 
-push!(trial2, 21, 0, 41, 51)
+push!(trial2, TrialContents(21, 0, 41, 51, nothing, nothing, nothing))
 @test length(trial2) == 3
 deleteat!(trial2, 3)
 @test length(trial1) == length(trial2) == 2
@@ -33,8 +32,10 @@ trial2.params = trial1.params
 
 @test trial1 == trial2
 
-@test trial1[2] ==
-    push!(BenchmarkTools.Trial(BenchmarkTools.Parameters(; evals=2)), 21, 0, 4, 5)
+@test trial1[2] == push!(
+    BenchmarkTools.Trial(BenchmarkTools.Parameters(; evals=2)),
+    TrialContents(21, 0, 4, 5, nothing, nothing, nothing),
+)
 @test trial1[1:end] == trial1
 
 @test time(trial1) == time(trial2) == 2.0
@@ -61,11 +62,11 @@ rmskew!(trial3)
 randtrial = BenchmarkTools.Trial(BenchmarkTools.Parameters())
 
 for _ in 1:40
-    push!(randtrial, rand(1:20), 1, 1, 1)
+    push!(randtrial, TrialContents(rand(1:20), 1, 1, 1))
 end
 
 while mean(randtrial) <= median(randtrial)
-    push!(randtrial, rand(10:20), 1, 1, 1)
+    push!(randtrial, TrialContents(rand(10:20), 1, 1, 1))
 end
 
 rmskew!(randtrial)
@@ -230,7 +231,7 @@ tj_r_2 = judge(tr; time_tolerance=2.0, memory_tolerance=2.0)
 @test BenchmarkTools.prettymemory(1073741824) == "1.00 GiB"
 
 @test sprint(show, "text/plain", ta) == sprint(show, ta; context=:compact => false) == """
-BenchmarkTools.TrialEstimate: 
+BenchmarkTools.TrialEstimate:
   time:             0.490 ns
   gctime:           0.000 ns (0.00%)
   memory:           2 bytes
@@ -273,7 +274,7 @@ BenchmarkTools.Trial: 2 samples with 1 evaluation.
  Time  (median):     1.005 ns             ┊ GC (median):    0.00%
  Time  (mean ± σ):   1.005 ns ± 0.007 ns  ┊ GC (mean ± σ):  0.00% ± 0.00%
 
-  █                                                       █  
+  █                                                       █
   █▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁█ ▁
   1 ns           Histogram: frequency by time       1.01 ns <