benchmark-ips 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b51b0526730c2f62df99ab99a7b9ee4455bd551
-  data.tar.gz: e831277bf0718b4451f172a5f379d9cefc6c7efe
+  metadata.gz: 800887a127821360c847dbd86fc49f386d388635
+  data.tar.gz: e0704aeb51a6f7d4983efc77b564a0989eb93502
 SHA512:
-  metadata.gz: 911bcd01427c54ac09b86ba506fe5c59b79eb0f8bff27ac58b79bfdd084de80aa91d0cec6fda0df9c591d55185ed4c922006039d6b74f597fcfb99045ce80a59
-  data.tar.gz: 7453a913d40e0c6751dbc5e69bdfa2cb749c387568ebaebaed9b401bf65c1adc8aa4aa56a7c9ba31f60e0e1ff27cc9473b3c961f6cc2e9538ad5be64e209b583
+  metadata.gz: cc0b35e7b9734ca9b5bdae5c8c74f5c06106d208e6d9aa85985b144e127354e81f0fe368492fabdd64df7dfb510339a30540fe745c9584c7bb1924d8f97a12e3
+  data.tar.gz: 10da5a56f4f9b1ba049d21823dfe1b737f54fc0667cd484cead92e2e22f8ae2fb38c58f353d23592523173096731a30f81129aed8d34904dd474594d411fb26a

data/History.txt

@@ -1,3 +1,15 @@
+=== 2.5.0 / 2016-02-14
+
+* 1 minor feature:
+  * Add iterations option.
+
+* 1 bug fixes:
+  * Don't tell people something is slower if it's within the error.
+
+* 2 merged PRs:
+  * Merge pull request #58 from chrisseaton/iterations
+  * Merge pull request #60 from chrisseaton/significance
+
 === 2.4.1 / 2016-02-12
 
 * 1 bug fix:

data/README.md

@@ -145,8 +145,6 @@ are independent of each other. You can do this with the `hold!` command.
 ```ruby
 Benchmark.ips do |x|
   
-  ...
-  
   # Hold results between multiple invocations of Ruby
   x.hold! 'filename'
   
@@ -157,6 +155,29 @@ This will run only one benchmarks each time you run the command, storing
 results in the specified file. The file is deleted when all results have been
 gathered and the report is shown.
 
+### Multiple iterations
+
+In some cases you may want to run multiple iterations of the warmup and
+calculation stages and take only the last result for comparison. This is useful
+if you are benchmarking with an implementation of Ruby that optimizes using
+tracing or on-stack-replacement, because to those implementations the
+calculation phase may appear as new, unoptimized code.
+
+You can do this with the `iterations` option, which by default is `1`. The
+total time spent will then be `iterations * warmup + iterations * time` seconds.
+
+```ruby
+Benchmark.ips do |x|
+
+  x.config(:iterations => 3)
+
+    # or
+  
+  x.iterations = 3
+  
+end
+```
+
 ## REQUIREMENTS:
 
 * None!

data/lib/benchmark/compare.rb

@@ -42,9 +42,21 @@ module Benchmark
 
       sorted.each do |report|
         name = report.label.to_s
-
-        x = (best.ips.to_f / report.ips.to_f)
-        $stdout.printf "%20s: %10.1f i/s - %.2fx slower\n", name, report.ips, x
+        
+        $stdout.printf "%20s: %10.1f i/s - ", name, report.ips
+        
+        best_low = best.ips - best.ips_sd
+        report_high = report.ips + report.ips_sd
+        overlaps = report_high > best_low 
+        
+        if overlaps
+          $stdout.print "same-ish: difference falls within error"
+        else
+          x = (best.ips.to_f / report.ips.to_f)
+          $stdout.printf "%.2fx slower", x
+        end
+        
+        $stdout.puts
       end
 
       $stdout.puts

data/lib/benchmark/ips.rb

@@ -13,10 +13,10 @@ module Benchmark
   module IPS
 
     # Benchmark-ips Gem version.
-    VERSION = "2.4.1"
+    VERSION = "2.5.0"
 
     # CODENAME of current version.
-    CODENAME = "Nonlinear Rollercoaster"
+    CODENAME = "Oceanload"
 
     # Measure code in block, each code's benchmarked result will display in
     # iteration per second with standard deviation in given time.
@@ -54,7 +54,6 @@ module Benchmark
       
       job.load_held_results if job.hold? && job.held_results?
 
-      job.run_warmup
       job.run
 
       $stdout.sync = sync

data/lib/benchmark/ips/job.rb

@@ -38,6 +38,10 @@ module Benchmark
       # @return [Integer]
       attr_accessor :time
 
+      # Warmup and calculation iterations.
+      # @return [Integer]
+      attr_accessor :iterations
+
       # Instantiate the Benchmark::IPS::Job.
       # @option opts [Benchmark::Suite] (nil) :suite Specify Benchmark::Suite.
       # @option opts [Boolean] (false) :quiet Suppress the printing of information.
@@ -56,15 +60,18 @@ module Benchmark
         # Default warmup and calculation time in seconds.
         @warmup = 2
         @time = 5
+        @iterations = 1
       end
 
       # Job configuration options, set +@warmup+ and +@time+.
       # @option opts [Integer] :warmup Warmup time.
       # @option opts [Integer] :time Calculation time.
+      # @option iterations [Integer] :time Warmup and calculation iterations.
       def config opts
         @warmup = opts[:warmup] if opts[:warmup]
         @time = opts[:time] if opts[:time]
         @suite = opts[:suite] if opts[:suite]
+        @iterations = opts[:iterations] if opts[:iterations]
       end
 
       # Return true if job needs to be compared.
@@ -158,10 +165,29 @@ module Benchmark
           [result['item'], result]
         }]
       end
+      
+      def run
+        @stdout.start_warming if @stdout
+        @iterations.times do
+          run_warmup
+        end
+        
+        @stdout.start_running if @stdout
+        
+        held = nil
+        
+        @iterations.times do |n|
+          held = run_benchmark
+        end
+        
+        if held
+          puts
+          puts 'Pausing here -- run Ruby again to measure the next benchmark...'
+        end
+      end
 
       # Run warmup.
       def run_warmup
-        @stdout.start_warming if @stdout
         @list.each do |item|
           next if hold? && @held_results && @held_results.key?(item.label)
           
@@ -194,8 +220,7 @@ module Benchmark
       end
 
       # Run calculation.
-      def run
-        @stdout.start_running if @stdout
+      def run_benchmark
         @list.each do |item|
           if hold? && @held_results && @held_results.key?(item.label)
            result = @held_results[item.label]
@@ -267,15 +292,15 @@ module Benchmark
               f.write "\n"
             end
             
-            puts
-            puts 'Pausing here -- run Ruby again to measure the next benchmark...'
-            break
+            return true
           end
         end
         
         if hold? && @full_report.entries.size == @list.size
           File.delete @held_path if File.exist?(@held_path)
         end
+        
+        false
       end
 
       # Run comparison of entries in +@full_report+.

data/lib/benchmark/ips/report.rb

@@ -137,6 +137,7 @@ module Benchmark
       # @return [Report::Entry] Last added entry.
       def add_entry label, microseconds, iters, ips, ips_sd, measurement_cycle
         entry = Entry.new(label, microseconds, iters, ips, ips_sd, measurement_cycle)
+        @entries.delete_if { |e| e.label == label }
         @entries << entry
         entry
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-ips
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest