benchmark_suite 0.8.0 → 1.0.0

data/Manifest.txt

@@ -4,10 +4,7 @@ Manifest.txt
 README.txt
 Rakefile
 bin/benchmark
-lib/benchmark/compare.rb
-lib/benchmark/ips.rb
 lib/benchmark/suite-run.rb
 lib/benchmark/suite.rb
-lib/benchmark/timing.rb
 lib/benchmark_suite.rb
 test/test_benchmark_suite.rb

data/README.txt

@@ -20,7 +20,7 @@ A set of enhancements to the standard library benchmark.rb
 
 require 'benchmark/ips'
 
-Benchmark.ips do
+Benchmark.ips do |x|
   # Typical mode, runs the block as many times as it can
   x.report("addition") { 1 + 2 }
 

data/Rakefile

@@ -12,6 +12,7 @@ require 'hoe'
 
 Hoe.spec 'benchmark_suite' do
   developer('Evan Phoenix', 'evan@fallingsnow.net')
+  dependency "benchmark-ips", "~> 1.0"
 end
 
 # vim: syntax=ruby

data/lib/benchmark/suite.rb

@@ -2,6 +2,8 @@ require 'benchmark'
 
 module Benchmark
   class Suite
+    @current = nil
+
     def self.current
       @current
     end
@@ -37,9 +39,10 @@ module Benchmark
       @reports = {}
       @order = []
       @quiet = false
+      @verbose = false
     end
 
-    attr_reader :reports
+    attr_reader :reports, :report
 
     def quiet!
       @quiet = true
@@ -82,7 +85,7 @@ module Benchmark
       rescue Exception => e
         STDOUT.puts "\nError in #{file}:"
         if e.respond_to? :render
-          e.render(STDERR)
+          e.render
         else
           STDOUT.puts e.backtrace
         end

data/lib/benchmark_suite.rb

@@ -1,3 +1,7 @@
+require 'benchmark/suite'
+require 'benchmark/ips'
+require 'benchmark/helpers'
+
 class BenchmarkSuite
-  VERSION = '0.8.0'
+  VERSION = '1.0.0'
 end

data/test/test_benchmark_suite.rb

@@ -2,7 +2,19 @@ require "test/unit"
 require "benchmark_suite"
 
 class TestBenchmarkSuite < Test::Unit::TestCase
-  def test_sanity
-    flunk "write tests or I will kneecap you"
+  def test_ips
+    s = Benchmark::Suite.create do |s|
+      s.quiet!
+
+      Benchmark.ips(1,1) do |x|
+        x.report("sleep") { sleep(0.25) }
+      end
+    end
+
+    rep = s.report.first
+
+    assert_equal "sleep", rep.label
+    assert_equal 4, rep.iterations
+    assert_in_delta 4.0, rep.ips, 0.2
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: benchmark_suite
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 8
   - 0
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Evan Phoenix
@@ -15,25 +15,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-05 00:00:00 -07:00
-default_executable: 
+date: 2012-03-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: benchmark-ips
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 41
+        hash: 15
         segments: 
-        - 2
-        - 9
         - 1
-        version: 2.9.1
-  type: :development
+        - 0
+        version: "1.0"
+  type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 14
+        version: "2.14"
+  type: :development
+  version_requirements: *id003
 description: A set of enhancements to the standard library benchmark.rb
 email: 
 - evan@fallingsnow.net
@@ -52,15 +80,11 @@ files:
 - README.txt
 - Rakefile
 - bin/benchmark
-- lib/benchmark/compare.rb
-- lib/benchmark/ips.rb
 - lib/benchmark/suite-run.rb
 - lib/benchmark/suite.rb
-- lib/benchmark/timing.rb
 - lib/benchmark_suite.rb
 - test/test_benchmark_suite.rb
 - .gemtest
-has_rdoc: true
 homepage: http://github.com/evanphx/benchmark_suite
 licenses: []
 
@@ -91,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: benchmark_suite
-rubygems_version: 1.6.2
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
 summary: A set of enhancements to the standard library benchmark.rb

data/lib/benchmark/compare.rb

@@ -1,41 +0,0 @@
-module Benchmark
-  def compare(*reports)
-    return if reports.size < 2
-
-    iter = false
-    sorted = reports.sort do |a,b|
-      if a.respond_to? :ips
-        iter = true
-        b.ips <=> a.ips
-      else
-        a.runtime <=> b.runtime
-      end
-    end
-
-    best = sorted.shift
-
-    STDOUT.puts "\nComparison:"
-
-    if iter
-      STDOUT.printf "%20s: %10.1f i/s\n", best.label, best.ips
-    else
-      STDOUT.puts "#{best.rjust(20)}: #{best.runtime}s"
-    end
-
-    sorted.each do |report|
-      name = report.label
-
-      if iter
-        x = (best.ips.to_f / report.ips.to_f)
-        STDOUT.printf "%20s: %10.1f i/s - %.2fx slower\n", name, report.ips, x
-      else
-        x = "%.2f" % (report.ips.to_f / best.ips.to_f)
-        STDOUT.puts "#{name.rjust(20)}: #{report.runtime}s - #{x}x slower"
-      end
-    end
-
-    STDOUT.puts
-  end
-
-  module_function :compare
-end

data/lib/benchmark/ips.rb

@@ -1,243 +0,0 @@
-# encoding: utf-8
-require 'benchmark/timing'
-require 'benchmark/compare'
-
-module Benchmark
-
-  class IPSReport
-    def initialize(label, us, iters, ips, ips_sd, cycles)
-      @label = label
-      @microseconds = us
-      @iterations = iters
-      @ips = ips
-      @ips_sd = ips_sd
-      @measurement_cycle = cycles
-    end
-
-    attr_reader :label, :microseconds, :iterations, :ips, :ips_sd, :measurement_cycle
-
-    def seconds
-      @microseconds.to_f / 1_000_000.0
-    end
-
-    def stddev_percentage
-      100.0 * (@ips_sd.to_f / @ips.to_f)
-    end
-
-    alias_method :runtime, :seconds
-
-    def body
-      left = "%10.1f (±%.1f%%) i/s" % [ips, stddev_percentage]
-      left.ljust(20) + (" - %10d in %10.6fs (cycle=%d)" % 
-                          [@iterations, runtime, @measurement_cycle])
-    end
-
-    def header
-      @label.rjust(20)
-    end
-
-    def to_s
-      "#{header} #{body}"
-    end
-
-    def display
-      STDOUT.puts to_s
-    end
-  end
-
-  class IPSJob
-    class Entry
-      def initialize(label, action)
-        @label = label
-
-        if action.kind_of? String
-          compile action
-          @action = self
-          @as_action = true
-        else
-          unless action.respond_to? :call
-            raise ArgumentError, "invalid action, must respond to #call"
-          end
-
-          @action = action
-
-          if action.respond_to? :arity and action.arity > 0
-            @call_loop = true
-          else
-            @call_loop = false
-          end
-
-          @as_action = false
-        end
-      end
-
-      attr_reader :label, :action
-
-      def as_action?
-        @as_action
-      end
-
-      def call_times(times)
-        return @action.call(times) if @call_loop
-
-        act = @action
-
-        i = 0
-        while i < times
-          act.call
-          i += 1
-        end
-      end
-
-      def compile(str)
-        m = (class << self; self; end)
-        code = <<-CODE
-          def call_times(__total);
-            __i = 0
-            while __i < __total
-              #{str};
-              __i += 1
-            end
-          end
-        CODE
-        m.class_eval code
-      end
-    end
-
-    def initialize
-      @list = []
-      @compare = false
-    end
-
-    attr_reader :compare
-
-    def compare!
-      @compare = true
-    end
-
-    #
-    # Registers the given label and block pair in the job list.
-    #
-    def item(label="", str=nil, &blk) # :yield:
-      if blk and str
-        raise ArgmentError, "specify a block and a str, but not both"
-      end
-
-      action = str || blk
-      raise ArgmentError, "no block or string" unless action
-
-      @list.push Entry.new(label, action)
-      self
-    end
-
-    alias_method :report, :item
-
-    # An array of 2-element arrays, consisting of label and block pairs.
-    attr_reader :list
-  end
-
-  def ips(time=5, warmup=2)
-    suite = nil
-
-    sync, STDOUT.sync = STDOUT.sync, true
-
-    if defined? Benchmark::Suite and Suite.current
-      suite = Benchmark::Suite.current
-    end
-
-    job = IPSJob.new
-    yield job
-
-    start = Timing::TimeVal.new
-    cur = Timing::TimeVal.new
-
-    before = Timing::TimeVal.new
-    after = Timing::TimeVal.new
-
-    reports = []
-
-    job.list.each do |item|
-      suite.warming item.label, warmup if suite
-
-      Timing.clean_env
-
-      if !suite or !suite.quiet?
-        if item.label.size > 20
-          STDOUT.print "#{item.label}\n#{' ' * 20}"
-        else
-          STDOUT.print item.label.rjust(20)
-        end
-      end
-
-      before.update!
-      start.update!
-      cur.update!
-
-      warmup_iter = 0
-
-      until start.elapsed?(cur, warmup)
-        item.call_times(1)
-        warmup_iter += 1
-        cur.update!
-      end
-
-      after.update!
-
-      warmup_time = before.diff(after)
-
-      # calculate the time to run approx 100ms
-      
-      cycles_per_100ms = ((100_000 / warmup_time.to_f) * warmup_iter).to_i
-      cycles_per_100ms = 1 if cycles_per_100ms <= 0
-
-      suite.warmup_stats warmup_time, cycles_per_100ms if suite
-
-      Timing.clean_env
-
-      suite.running item.label, time if suite
-
-      iter = 0
-      start.update!
-      cur.update!
-
-      measurements = []
-
-      until start.elapsed?(cur, time)
-        before.update!
-        item.call_times cycles_per_100ms
-        after.update!
-
-        iter += cycles_per_100ms
-        cur.update!
-
-        measurements << before.diff(after)
-      end
-
-      measured_us = measurements.inject(0) { |a,i| a + i }
-
-      seconds = measured_us.to_f / 1_000_000.0
-
-      all_ips = measurements.map { |i| cycles_per_100ms.to_f / (i.to_f / 1_000_000) }
-
-      avg_ips = Timing.mean(all_ips)
-      sd_ips =  Timing.stddev(all_ips).round
-
-      rep = IPSReport.new(item.label, measured_us, iter, avg_ips, sd_ips, cycles_per_100ms)
-
-      STDOUT.puts " #{rep.body}" if !suite or !suite.quiet?
-
-      suite.add_report rep, caller(1).first if suite
-
-      STDOUT.sync = sync
-
-      reports << rep
-    end
-
-    if job.compare
-      Benchmark.compare *reports
-    end
-  end
-
-
-  module_function :ips
-end

data/lib/benchmark/timing.rb

@@ -1,137 +0,0 @@
-if !defined?(RUBY_ENGINE) or RUBY_ENGINE != "rbx"
-  require 'rubygems'
-end
-
-require 'ffi'
-
-module Benchmark
-  module Timing
-    extend FFI::Library
-
-    ffi_lib FFI::Library::LIBC
-
-    attach_function :gettimeofday, [:pointer, :pointer], :int
-
-    class TimeVal < FFI::Struct
-      layout :tv_sec, :time_t, :tv_usec, :suseconds_t
-
-      def sec
-        self[:tv_sec]
-      end
-
-      def usec
-        self[:tv_usec]
-      end
-
-      def update!
-        Timing.gettimeofday to_ptr, nil
-      end
-
-      def to_time
-        Time.at sec, usec
-      end
-
-      def <(tv)
-        return true if sec < tv.sec
-        return true if usec < tv.usec
-        return false
-      end
-
-      def ==(tv)
-        if sec == tv.sec and usec == tv.usec
-          return true
-        end
-        return false
-      end
-
-      def diff(tv)
-        if tv.sec == sec
-          return tv.usec - usec
-        end
-
-        sec_diff = tv.sec - sec
-
-        usec_diff = tv.usec - usec
-        if usec_diff < 0
-          sec_diff -= 1
-          usec_diff += 1_000_000
-        end
-
-        (sec_diff * 1_000_000) + usec_diff
-      end
-
-      def >(tv)
-        tv < self
-      end
-
-      def elapsed?(tv, second)
-        target = sec + second
-        cur_tv = tv.sec
-
-        return true if target < cur_tv
-        return true if target == cur_tv and usec < tv.usec
-
-        return false
-      end
-
-    end
-
-    def self.resolution
-      samples = []
-
-      t1 = TimeVal.new
-      t2 = TimeVal.new
-
-      30.times do
-        t1.update!
-
-        while true
-          t2.update!
-          break if t2 != t1
-        end
-
-        samples << t1.diff(t2)
-      end
-
-      sum = samples.inject(0) { |acc, i| acc + i }
-      sum / 30
-    end
-
-    def self.mean(samples)
-      sum = samples.inject(0) { |acc, i| acc + i }
-      sum / samples.size
-    end
-
-    def self.variance(samples, m=nil)
-      m ||= mean(samples)
-
-      total = samples.inject(0) { |acc, i| acc + ((i - m) ** 2) }
-
-      total / samples.size
-    end
-
-    def self.stddev(samples, m=nil)
-      Math.sqrt variance(samples, m)
-    end
-
-    def self.resample_mean(samples, resample_times=100)
-      resamples = []
-
-      resample_times.times do
-        resample = samples.map { samples[rand(samples.size)] }
-        resamples << Timing.mean(resample)
-      end
-
-      resamples
-    end
-
-    def self.clean_env
-      # rbx
-      if GC.respond_to? :run
-        GC.run(true)
-      else
-        GC.start
-      end
-    end
-  end
-end