better-benchmark 0.8.6 → 0.8.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTc2OWI4OTQ3ZDg3M2FiNmQ3YTE3NmFmZmRhMmVlMWYyZGYzNWY5Yg==
+    Zjk4NGViMGUxNTI0M2JiNTFhOTQ2ODFkZmU2ZjFhNjI2ODI3NjRkMw==
   data.tar.gz: !binary |-
-    Y2Y3NzViNzA4MGE2OWVmYzkyMmU0MDdkZGQxOGQzYTBjM2YzZWE0Zg==
-!binary "U0hBNTEy":
+    NjM3YWU5MTg1MmU4ZGZiNTE3YmE0YjI1MDkzYjljOGQ3MmRkNDRkOA==
+SHA512:
   metadata.gz: !binary |-
-    N2RjNzBlNDAyMWRkYjY0NzdhYmJhYTJjMmZiNzE2ZTJhZmE1NTBjNmM2YTRm
-    MDEzZDY1NDYyMTU2ZDQ0YWIyZDBjNDQ0M2I2NGQ1MDdhNWY3YWU2NjNmNzBm
-    M2ZhMDJmMmQ5ODE1NzE1ODhjZjg3Y2ZkNDVjNjcwN2Q0MDMyZDc=
+    ZGI3ODdiMmVkMTA0YjIwZGIzN2FmMGIzMzhmZWQwYjEwNmRkZmQ4MzFiMmJi
+    MGM2YTJlMjU5Mjc5OWMyZmY0NDEzODBjMTcxODU2ZGYwNjk0NjVmY2I5MDcz
+    MzY4Yjc3NTU1MWE5OGVlOGEyZGJmOGQ1OGVjZmEzMTg4MzRkZTA=
   data.tar.gz: !binary |-
-    NGRkMzIxMDc4ZWJmOWFmNzY4OWJmYjVhNGNkZjU3NjFhZTM4NDJjYjFhOWVh
-    M2Y5MjEwNWU5OWI0ZWYwYmMxYTMzNTAwNWVhM2IzM2JkNTNmN2Q0M2M1Mjdk
-    YzI2ZGE4ZjNkMzk1MDFlMzQ0Y2RiZGI1ZTBhNjUyN2VhYzRlODI=
+    ZDNkNDBlNDQ2Mzc5OWVmNTVmZTcxZmM2ZTk2Zjc4YjA5MmVjMDQ1YTk5NTI1
+    NGM0YzIzZDY1MjcxZDg2YzVkYjhhZDhmNTM4OTFkYWI0NmYzYTY3NGIzZTg1
+    ZTc3MjM3NmE3MjdhYTllNGZhYmQwYzkwMDY4OWI1YzNmZWVlODc=

data/README.md

@@ -17,6 +17,15 @@ Statistically correct benchmarking for Ruby.
 Change the argument of `--with-R-dir` to whatever is appropriate for your system
 if either of the above don't work.
 
+### With Bundler
+
+Bundler needs to be configured to use the build option:
+
+    # Linux:
+    bundle config build.rsruby --with-R-dir=/usr/lib/R
+    # OSX:
+    bundle config build.rsruby --with-R-dir=/Library/Frameworks/R.framework/Resources
+
 ## Usage
 
 ### Comparing code blocks

data/lib/better-benchmark.rb

@@ -7,7 +7,7 @@ require 'better-benchmark/comparer'
 
 module Benchmark
 
-  BETTER_BENCHMARK_VERSION = '0.8.6'
+  BETTER_BENCHMARK_VERSION = '0.8.7'
   DEFAULT_REQUIRED_SIGNIFICANCE = 0.01
 
   def self.write_realtime( data_dir, &block )
@@ -47,15 +47,18 @@ module Benchmark
     }
   end
 
-  # Options:
-  #   :iterations
-  #     The number of times to execute the pair of blocks.
-  #   :inner_iterations
-  #     Used to increase the time taken per iteration.
-  #   :required_significance
-  #     Maximum allowed p value in order to declare the results statistically significant.
-  #   :verbose
-  #     Whether to print a dot for each iteration (as a sort of progress meter).
+  # @param options [Hash]
+  # @option options [Fixnum] :iterations
+  #   The number of times to execute the pair of blocks.
+  # @option options [Fixnum] :inner_iterations
+  #   Used to increase the time taken per iteration.
+  # @option options [Fixnum] :warmup_iterations
+  #   How many inner iterations to run beforehand, and not measure the time for.
+  #   This number does not reduce the number of :inner_iterations .
+  # @option options [Float] :required_significance
+  #   Maximum allowed p value in order to declare the results statistically significant.
+  # @option options [Boolean] :verbose
+  #   Whether to print a dot for each iteration (as a sort of progress meter).
   #
   # To use better-benchmark properly, it is important to set :iterations and
   # :inner_iterations properly.  There are a few things to bear in mind:
@@ -66,7 +69,7 @@ module Benchmark
   # small (or else random variance will muddle the results).  Aim for at least
   # 1.0 seconds per iteration.
   # (3) Minimize the proportion of any warmup time (and cooldown time) of one
-  # block run.
+  # block run (or use :warmup_iterations to eliminate this factor entirely).
   #
   # In order to achieve these goals, you will need to tweak :inner_iterations
   # based on your situation.  The exact number you should use will depend on
@@ -74,15 +77,6 @@ module Benchmark
   # by the blocks.  For code blocks that execute extremely rapidly, you may
   # need hundreds of thousands of :inner_iterations.
   def self.compare_realtime( options = {}, &block1 )
-    options[ :iterations ] ||= 20
-    options[ :inner_iterations ] ||= 1
-
-    if options[ :iterations ] > 30
-      warn "The number of iterations is set to #{options[ :iterations ]}.  " +
-        "Using too many iterations may make the test results less reliable.  " +
-        "It is recommended to increase the number of :inner_iterations instead."
-    end
-
     ComparisonPartial.new( block1, options )
   end
 

data/lib/better-benchmark/comparison-partial.rb

@@ -1,33 +1,51 @@
 module Benchmark
   class ComparisonPartial
+    # @param options [Hash] @see Benchmark.compare_realtime
     def initialize( block, options )
       @block1 = block
       @options = options
+
+      @options[:iterations] ||= 20
+      @options[:inner_iterations] ||= 1
+      @options[:warmup_iterations] ||= 0
+
+      if @options[:iterations] > 30
+        warn "The number of iterations is set to #{@options[:iterations]}.  " +
+        "Using too many iterations may make the test results less reliable.  " +
+        "It is recommended to increase the number of :inner_iterations instead."
+      end
     end
 
     def with( &block2 )
       times1 = []
       times2 = []
 
-      (1..@options[ :iterations ]).each do |iteration|
-        if @options[ :verbose ]
+      (1..@options[:iterations]).each do |iteration|
+        if @options[:verbose]
           $stdout.print "."; $stdout.flush
         end
 
+        @options[:warmup_iterations].times do |i|
+          @block1.call( iteration )
+        end
         times1 << Benchmark.realtime do
-          @options[ :inner_iterations ].times do |i|
+          @options[:inner_iterations].times do |i|
             @block1.call( iteration )
           end
         end
+
+        @options[:warmup_iterations].times do |i|
+          block2.call( iteration )
+        end
         times2 << Benchmark.realtime do
-          @options[ :inner_iterations ].times do |i|
+          @options[:inner_iterations].times do |i|
             block2.call( iteration )
           end
         end
       end
 
-      ::Benchmark.compare_times( times1, times2, @options[ :required_significance ] )
+      ::Benchmark.compare_times( times1, times2, @options[:required_significance] )
     end
     alias to with
   end
-end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: better-benchmark
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.7
 platform: ruby
 authors:
 - Pistos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 description: Statistically correct benchmarking for Ruby.
@@ -45,7 +45,8 @@ files:
 - bin/bbench
 - bin/bbench-compare
 homepage: http://github.com/Pistos/better-benchmark
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -64,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - ! 'The R project: http://www.r-project.org/'
 rubyforge_project: better-benchmark
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Statistically correct benchmarking for Ruby.