fruity 0.1.0 → 0.2.0

data/README.rdoc

@@ -98,8 +98,8 @@ In addition, all benchmarking tools require the user to either write their own i
 
 == Algorithm
 
-We first determine the number of inner iterations needed to get a meaningful clock measurement (see sufficient_magnitude).
-When timing an execution, we always compare to a baseline (the time taken by an empty loop of the same magnitude).
+We first determine the number of inner iterations needed to get a meaningful clock measurement (see sufficient_magnification).
+When timing an execution, we always compare to a baseline (the time taken by an empty loop of the same magnification).
 We call the different executables in succession, to minimize the impact on the order of execution.
 We calculate the error by taking into account the standard deviation of the time samples.
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/fruity.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "fruity"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marc-Andre Lafortune"]
+  s.date = "2012-02-08"
+  s.description = "Comparing apples with apples"
+  s.email = "github@marc-andre.ca"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".irbrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fruity.gemspec",
+    "lib/fruity.rb",
+    "lib/fruity/base.rb",
+    "lib/fruity/baseline.rb",
+    "lib/fruity/comparison_run.rb",
+    "lib/fruity/group.rb",
+    "lib/fruity/named_block_collector.rb",
+    "lib/fruity/runner.rb",
+    "lib/fruity/util.rb",
+    "spec/baseline_spec.rb",
+    "spec/comparison_run_spec.rb",
+    "spec/find_thresold.rb",
+    "spec/fruity_spec.rb",
+    "spec/group_spec.rb",
+    "spec/manual_test.rb",
+    "spec/runner_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/util_spec.rb"
+  ]
+  s.homepage = "http://github.com/marcandre/fruity"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Cool performance comparison tool"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+  end
+end
+

data/lib/fruity/base.rb

@@ -12,12 +12,12 @@ module Fruity
     :on         => GLOBAL_SCOPE,
     :samples    => 20,
     :disable_gc => false,
-    :filter     => [0, 0.2],
-    :baseline   => :split,
+    :filter     => [0, 0.2],        # Proportion of samples to discard [lower_end, upper_end]
+    :baseline   => :single,         # Either :none, :single or :split
   }
 
   OTHER_OPTIONS = [
-    :magnitude,
+    :magnify,
     :args,
     :self,
     :verbose,

data/lib/fruity/group.rb

@@ -37,19 +37,19 @@ module Fruity
       compare_block(block) if block
     end
 
-    # Returns the maximal sufficient_magnitude for all elements
-    # See Util.sufficient_magnitude
+    # Returns the maximal sufficient_magnification for all elements
+    # See Util.sufficient_magnification
     #
-    def sufficient_magnitude
-      elements.map{|name, exec| Util.sufficient_magnitude(exec, options) }.max
+    def sufficient_magnification
+      elements.map{|name, exec| Util.sufficient_magnification(exec, options) }.max
     end
 
-    # Returns the maximal sufficient_magnitude for all elements
+    # Returns the maximal sufficient_magnification for all elements
     # and the approximate delay taken for the whole group
-    # See Util.sufficient_magnitude
+    # See Util.sufficient_magnification
     #
-    def sufficient_magnitude_and_delay
-      mags_and_delays = elements.map{|name, exec| Util.sufficient_magnitude_and_delay(exec, options) }
+    def sufficient_magnification_and_delay
+      mags_and_delays = elements.map{|name, exec| Util.sufficient_magnification_and_delay(exec, options) }
       mag = mags_and_delays.map(&:first).max
       delay = mags_and_delays.map{|m, d| d * mag / m}.inject(:+)
       [mag, delay]

data/lib/fruity/runner.rb

@@ -9,7 +9,7 @@ module Fruity
     end
 
     def feedback
-      mess = "Running each test " << (options[:magnitude] == 1 ? "once." : "#{options[:magnitude]} times.")
+      mess = "Running each test " << (options[:magnify] == 1 ? "once." : "#{options[:magnify]} times.")
       if d = delay
         if d > 60
           d = (d / 60).round
@@ -23,8 +23,8 @@ module Fruity
   private
     def prepare(opt)
       @options = group.options.merge(opt)
-      unless options[:magnitude]
-        options[:magnitude], @delay = group.sufficient_magnitude_and_delay
+      unless options[:magnify]
+        options[:magnify], @delay = group.sufficient_magnification_and_delay
         @delay *= options.fetch(:samples)
       end
     end

data/lib/fruity/util.rb

@@ -38,30 +38,30 @@ module Fruity
     # due in big part to the imprecision of the measurement itself
     # or the inner loop itself.
     #
-    def sufficient_magnitude(exec, options = {})
-      mag, delay = sufficient_magnitude_and_delay(exec, options)
+    def sufficient_magnification(exec, options = {})
+      mag, delay = sufficient_magnification_and_delay(exec, options)
       mag
     end
 
     BASELINE_THRESHOLD = 1.02 # Ratio between two identical baselines is typically < 1.02, while {2+2} compared to baseline is typically > 1.02
 
-    def sufficient_magnitude_and_delay(exec, options = {})
+    def sufficient_magnification_and_delay(exec, options = {})
       power = 0
       min_desired_delta = clock_precision * MEASUREMENTS_BY_PROPER_TIME / PROPER_TIME_RELATIVE_ERROR
       # First, make a gross approximation with a single sample and no baseline
       min_approx_delay = min_desired_delta / (1 << APPROX_POWER)
-      while (delay = real_time(exec, options.merge(:magnitude => 1 << power))) < min_approx_delay
+      while (delay = real_time(exec, options.merge(:magnify => 1 << power))) < min_approx_delay
         power += [Math.log(min_approx_delay.div(delay + clock_precision), 2), 1].max.floor
       end
 
       # Then take a couple of samples, along with a baseline
       power += 1 unless delay > 2 * min_approx_delay
-      group = Group.new(exec, Baseline[exec], options.merge(:baseline => :none, :samples => 5, :filter => [0, 0.25], :magnitude => 1 << power))
+      group = Group.new(exec, Baseline[exec], options.merge(:baseline => :none, :samples => 5, :filter => [0, 0.25], :magnify => 1 << power))
       stats = group.run.stats
       if stats[0][:mean] / stats[1][:mean] < 2
         # Quite close to baseline, which means we need to be more discriminant
         power += APPROX_POWER
-        stats = group.run(:samples => 40, :magnitude => 1 << power).stats
+        stats = group.run(:samples => 40, :magnify => 1 << power).stats
         raise "Given callable can not be reasonably distinguished from an empty block" if stats[0][:mean] / stats[1][:mean] < BASELINE_THRESHOLD
       end
       delta = stats[0][:mean] - stats[1][:mean]
@@ -73,25 +73,25 @@ module Fruity
     end
 
     # The proper time is the real time taken by calling +exec+
-    # number of times given by +options[:magnitude]+ minus
+    # number of times given by +options[:magnify]+ minus
     # the real time for calling an empty executable instead.
     #
-    # If +options[:magnitude]+ is not given, it will be calculated to be meaningful.
+    # If +options[:magnify]+ is not given, it will be calculated to be meaningful.
     #
     def proper_time(exec, options = {})
-      unless options.has_key?(:magnitude)
-        options = {:magnitude => sufficient_magnitude(exec, options)}.merge(options)
+      unless options.has_key?(:magnify)
+        options = {:magnify => sufficient_magnification(exec, options)}.merge(options)
       end
       real_time(exec, options) - real_time(Baseline[exec], options)
     end
 
     # Returns the real time taken by calling +exec+
-    # number of times given by +options[:magnitude]+
+    # number of times given by +options[:magnify]+
     #
     def real_time(exec, options = {})
       GC.start
       GC.disable if options[:disable_gc]
-      n = options.fetch(:magnitude)
+      n = options.fetch(:magnify)
       if options.has_key?(:self)
         new_self = options[:self]
         if args = options[:args] and args.size > 0

data/spec/find_thresold.rb

@@ -7,7 +7,7 @@ min = 1
 max = 2
 s = 10
 n.times.map do
-  group = Fruity::Group.new(*[->{}] * s, *[->{ 2 + 2 }] * s, :baseline => :none, :samples => 20, :magnitude => 1 << power)
+  group = Fruity::Group.new(*[->{}] * s, *[->{ 2 + 2 }] * s, :baseline => :none, :samples => 20, :magnify => 1 << power)
   means = group.run.stats.map{|s| s[:mean]}
   noops = means.first(s).sort
   plus  = means.last(s).sort

data/spec/runner_spec.rb

@@ -6,19 +6,19 @@ module Fruity
     let(:runner){ Runner.new(group) }
 
     it "runs from a Group" do
-      run = runner.run(:samples => 42, :magnitude => 100)
+      run = runner.run(:samples => 42, :magnify => 100)
       run.timings.should be_array_of_size(2, 42)
       run.baselines.should be_array_of_size(2, 42)
     end
 
     it "can use a single baseline" do
-      run = runner.run(:samples => 42, :magnitude => 100, :baseline => :single)
+      run = runner.run(:samples => 42, :magnify => 100, :baseline => :single)
       run.timings.should be_array_of_size(2, 42)
       run.baselines.should be_array_of_size(42)
     end
 
     it "can use no baseline" do
-      run = runner.run(:samples => 42, :magnitude => 100, :baseline => :none)
+      run = runner.run(:samples => 42, :magnify => 100, :baseline => :none)
       run.timings.should be_array_of_size(2, 42)
       run.baselines.should == nil
     end

data/spec/util_spec.rb

@@ -6,18 +6,18 @@ module Fruity
 
     its(:proper_time_precision) { should == 4.0e-06 }
 
-    describe :sufficient_magnitude do
+    describe :sufficient_magnification do
       it "returns a big value for a quick (but not trivial)" do
-        Util.sufficient_magnitude(->{ 2.nil? }).should > 10000
+        Util.sufficient_magnification(->{ 2 + 2 }).should > 10000
       end
 
       it "return 1 for a sufficiently slow block" do
-        Util.sufficient_magnitude(->{sleep(0.01)}).should == 1
+        Util.sufficient_magnification(->{sleep(0.01)}).should == 1
       end
 
       it "should raise an error for a trivial block" do
         ->{
-          Util.sufficient_magnitude(Proc.new{})
+          Util.sufficient_magnification(->{})
         }.should raise_error
       end
     end
@@ -46,7 +46,7 @@ module Fruity
 
       it "gives similar results when comparing an exec and its baseline from stats on proper_time" do
         exec = ->{ 2 ** 3 ** 4 }
-        options = {:magnitude => Util.sufficient_magnitude(exec) }
+        options = {:magnify => Util.sufficient_magnification(exec) }
         n = 100
         timings  = [exec, ->{}].map do |e|
           n.times.map { Util.real_time(e, options) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fruity
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2170028460 !ruby/object:Gem::Requirement
+  requirement: &2158896760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2170028460
+  version_requirements: *2158896760
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2170027780 !ruby/object:Gem::Requirement
+  requirement: &2158895780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2170027780
+  version_requirements: *2158895780
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2170047220 !ruby/object:Gem::Requirement
+  requirement: &2158895160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2170047220
+  version_requirements: *2158895160
 description: Comparing apples with apples
 email: github@marc-andre.ca
 executables: []
@@ -59,6 +59,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- fruity.gemspec
 - lib/fruity.rb
 - lib/fruity/base.rb
 - lib/fruity/baseline.rb
@@ -92,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3031735817276906554
+      hash: 269285252031009011
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: