benchmark-ips 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaebdee644671b1a757ded5e4868e1035718834832d2cfec8eb4460a3fa33171
-  data.tar.gz: a7349d06bb190b2ea9b7c06caf8da4ba26a48b00e550ca8a71ed1fe22ddff290
+  metadata.gz: 941e6893612b6307694098b25ebe3cc688dac27020c98cf76d603ead0bd72299
+  data.tar.gz: 622715bcc49a8e11c1c6285b35745b9115417e1055b8dc394ca6f5ba07186b66
 SHA512:
-  metadata.gz: 5b2cef3b3b852b48eb8cdbaa1b51b728edb0760d77983d5408e81a44d9dfc280f257456a57d8a213155ca0752508c81282e243daf2cbb16d1a95bdaac1b4d211
-  data.tar.gz: 509f946e113907d26745e24a07675684b6870189fcdc36128380b286e774bb03e46a4608b3852aa68e110a2c1e594436e727b9626111bebf1b1a4bdeea7f71f8
+  metadata.gz: b0e5c2205809523369329ea675f095dc62cefa330e6adb6005b12a6ff4f4d5cfd38ffc16fe819761e4ed10a2c41b1100af8304c3a038383d2377700436873bbb
+  data.tar.gz: 318217090715cb2a541606ef8ab91087aec9238ffa0d6b29d5b2b1eeebc2e5d0a725856b59ded62081f1135f2a8bb916c25a31d604c0824accaf67e46ecfab8f

data/README.md

@@ -4,7 +4,7 @@
 * home :: https://github.com/evanphx/benchmark-ips
 
 [![Gem Version](https://badge.fury.io/rb/benchmark-ips.svg)](http://badge.fury.io/rb/benchmark-ips)
-[![Build Status](https://secure.travis-ci.org/evanphx/benchmark-ips.svg)](http://travis-ci.org/evanphx/benchmark-ips)
+[![CI](https://github.com/evanphx/benchmark-ips/actions/workflows/ci.yml/badge.svg)](https://github.com/evanphx/benchmark-ips/actions/workflows/ci.yml)
 [![Inline docs](http://inch-ci.org/github/evanphx/benchmark-ips.svg)](http://inch-ci.org/github/evanphx/benchmark-ips)
 
 * https://github.com/evanphx/benchmark-ips

data/lib/benchmark/compare.rb

@@ -56,6 +56,8 @@ module Benchmark
     def compare(*entries, order: :fastest)
       return if entries.size < 2
 
+      max_width = entries.map { |e| e.label.to_s.size }.max
+
       case order
       when :baseline
         baseline = entries.shift
@@ -69,12 +71,12 @@ module Benchmark
 
       $stdout.puts "\nComparison:"
 
-      $stdout.printf "%20s: %10.1f i/s\n", baseline.label.to_s, baseline.stats.central_tendency
+      $stdout.printf "%#{max_width}s: %10.1f i/s\n", baseline.label.to_s, baseline.stats.central_tendency
 
       sorted.each do |report|
         name = report.label.to_s
 
-        $stdout.printf "%20s: %10.1f i/s - ", name, report.stats.central_tendency
+        $stdout.printf "%#{max_width}s: %10.1f i/s - ", name, report.stats.central_tendency
 
         if report.stats.overlaps?(baseline.stats)
           $stdout.print "same-ish: difference falls within error"

data/lib/benchmark/ips/job/stream_report.rb

@@ -2,9 +2,10 @@ module Benchmark
   module IPS
     class Job
       class StreamReport
-        def initialize(stream = $stdout)
+        def initialize(job, stream = $stdout)
           @last_item = nil
           @out = stream
+          @job = job
         end
 
         def start_warming
@@ -17,8 +18,9 @@ module Benchmark
         end
 
         def warming(label, _warmup)
-          @out.print rjust(label)
+          @out.print label.to_s.rjust(@job.max_width)
         end
+        alias_method :running, :warming
 
         def warmup_stats(_warmup_time_us, timing)
           case format
@@ -29,8 +31,6 @@ module Benchmark
           end
         end
 
-        alias_method :running, :warming
-
         def add_report(item, caller)
           @out.puts " #{item.body}"
           @last_item = item
@@ -48,18 +48,6 @@ module Benchmark
         def format
           Benchmark::IPS.options[:format]
         end
-
-        # Add padding to label's right if label's length < 20,
-        # Otherwise add a new line and 20 whitespaces.
-        # @return [String] Right justified label.
-        def rjust(label)
-          label = label.to_s
-          if label.size > 20
-            "#{label}\n#{' ' * 20}"
-          else
-            label.rjust(20)
-          end
-        end
       end
     end
   end

data/lib/benchmark/ips/job.rb

@@ -9,7 +9,8 @@ module Benchmark
       # The percentage of the expected runtime to allow
       # before reporting a weird runtime
       MAX_TIME_SKEW = 0.05
-      POW_2_30 = 1 << 30
+      # Keep iterations below this to avoid overflow to 64-bit long or Bignum
+      MAX_ITERATIONS = 1 << 30
 
       # Two-element arrays, consisting of label and block pairs.
       # @return [Array<Entry>] list of entries
@@ -51,6 +52,10 @@ module Benchmark
       # @return [Integer]
       attr_accessor :confidence
 
+      # The maximum label width
+      # @return [Integer]
+      attr_reader :max_width
+
       # Silence output
       # @return [Boolean]
       def quiet
@@ -72,6 +77,7 @@ module Benchmark
         @compare_order = :fastest
         @held_path = nil
         @held_results = nil
+        @max_width = 20 # automatically computed as entries are added
 
         @timing = Hash.new 1 # default to 1 in case warmup isn't run
         @full_report = Report.new
@@ -85,7 +91,7 @@ module Benchmark
         @stats = :sd
         @confidence = 95
 
-        @out = MultiReport.new(StreamReport.new)
+        @out = MultiReport.new(StreamReport.new(self))
       end
 
       # Job configuration options, set +@warmup+ and +@time+.
@@ -106,7 +112,7 @@ module Benchmark
         if val # remove instances of StreamReport
           @out.quiet!
         else # ensure there is an instance of StreamReport
-          @out << StreamReport.new if @out.quiet?
+          @out << StreamReport.new(self) if @out.quiet?
         end
       end
 
@@ -180,6 +186,8 @@ module Benchmark
         action = str || blk
         raise ArgumentError, "no block or string" unless action
 
+        @max_width = label.size if label.size > @max_width
+
         @list.push Entry.new(label, action)
         self
       end
@@ -219,7 +227,7 @@ module Benchmark
         JSON.load(IO.read(@held_path)).each do |result|
           @held_results[result['item']] = result
           create_report(result['item'], result['measured_us'], result['iter'],
-                        create_stats(result['samples']), result['cycles'])
+                        create_stats(result['samples'], result['measured_us'], result['iter']), result['cycles'])
         end
       end
 
@@ -289,11 +297,13 @@ module Benchmark
 
             # If the number of cycles would go outside the 32-bit signed integers range
             # then exit the loop to avoid overflows and start the 100ms warmup runs
-            break if cycles >= POW_2_30
+            break if cycles >= MAX_ITERATIONS
             cycles *= 2
           end while Timing.now + warmup_time_us * 2 < target
 
-          cycles = cycles_per_100ms warmup_time_us, warmup_iter
+          per_100ms = cycles_per_100ms warmup_time_us, warmup_iter
+          # Not [per_100ms, MAX_ITERATIONS].min as that can promote the result to long
+          cycles = per_100ms > MAX_ITERATIONS ? MAX_ITERATIONS : per_100ms
           @timing[item] = cycles
 
           # Run for the remaining of warmup in a similar way as #run_benchmark.
@@ -349,7 +359,7 @@ module Benchmark
             iterations_per_sec cycles, time_us
           }
 
-          rep = create_report(item.label, measured_us, iter, create_stats(samples), cycles)
+          rep = create_report(item.label, measured_us, iter, create_stats(samples, measured_us, iter), cycles)
 
           if (final_time - target).abs >= (@time.to_f * MAX_TIME_SKEW)
             rep.show_total_time!
@@ -361,10 +371,10 @@ module Benchmark
         end
       end
 
-      def create_stats(samples)
+      def create_stats(samples, measured_us, iterations)
         case @stats
           when :sd
-            Stats::SD.new(samples)
+            Stats::SD.new(samples, measured_us, iterations)
           when :bootstrap
             Stats::Bootstrap.new(samples, @confidence)
           else

data/lib/benchmark/ips/report.rb

@@ -90,7 +90,15 @@ module Benchmark
 
           case Benchmark::IPS.options[:format]
           when :human
-            left = ("%s (±%4.1f%%) i/s" % [Helpers.scale(@stats.central_tendency), @stats.error_percentage]).ljust(20)
+            central_tendency = Helpers.scale(@stats.central_tendency)
+            error_percentage = @stats.error_percentage
+            left =
+              if error_percentage > 99.9
+                "%s (± Inf%%) i/s" % [central_tendency]
+              else
+                "%s (±%4.1f%%) i/s" % [central_tendency, @stats.error_percentage]
+              end.ljust(20)
+
             iters = Helpers.scale(@iterations)
 
             if @show_total_time

data/lib/benchmark/ips/share.rb

@@ -17,7 +17,7 @@ module Benchmark
         base = (ENV['SHARE_URL'] || DEFAULT_URL)
         url = URI(File.join(base, "reports"))
 
-        req = Net::HTTP::Post.new(url)
+        req = Net::HTTP::Post.new(url, initheader = {'Content-Type' =>'application/json'})
 
         data = {
           "entries" => @report.data,

data/lib/benchmark/ips/stats/sd.rb

@@ -6,9 +6,9 @@ module Benchmark
         include StatsMetric
         attr_reader :error, :samples
 
-        def initialize(samples)
+        def initialize(samples, measured_us, iterations)
           @samples = samples
-          @mean = Timing.mean(samples)
+          @mean = Timing::MICROSECONDS_PER_SECOND * (iterations.to_f / measured_us)
           @error = Timing.stddev(samples, @mean).round
         end
 

data/lib/benchmark/ips.rb

@@ -20,10 +20,10 @@ module Benchmark
   module IPS
 
     # Benchmark-ips Gem version.
-    VERSION = "2.14.0"
+    VERSION = "2.15.0"
 
     # CODENAME of current version.
-    CODENAME = "Akagi"
+    CODENAME = "Harmonic Nice"
 
     # Measure code in block, each code's benchmarked result will display in
     # iteration per second with standard deviation in given time.

data/lib/benchmark/timing.rb

@@ -4,9 +4,9 @@ module Benchmark
     # Microseconds per second.
     MICROSECONDS_PER_SECOND = 1_000_000
 
-    # Calculate (arithmetic) mean of given samples.
+    # Calculate arithmetic mean of given numbers.
     # @param [Array] samples Samples to calculate mean.
-    # @return [Float] Mean of given samples.
+    # @return [Float] Mean of given numbers.
     def self.mean(samples)
       sum = samples.inject(:+)
       sum / samples.size

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-ips
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Evan Phoenix
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-01-12 00:00:00.000000000 Z
@@ -72,7 +72,7 @@ homepage: https://github.com/evanphx/benchmark-ips
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -89,8 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: A iterations per second enhancement to Benchmark.
 test_files: []