benelux 0.5.4 → 0.5.5

data/CHANGES.txt

@@ -1,10 +1,13 @@
 BENELUX, CHANGES
 
+#### 0.5.5 (2010-01-16) ###############################
+
+* ADDED: Benelux.bm 
+
 #### 0.5.4 (2010-01-13) ###############################
 
 * CHANGE: Timeline#add_message now supports objects of any type (not just Strings)
 
-
 #### 0.5.3 (2009-11-16) ###############################
 
 * FIXED: Process dead threads only once

data/README.rdoc

@@ -1,6 +1,6 @@
 = Benelux v0.5
 
-<b>A mad timeline for your Ruby codes</b>
+<b>A mad way to time Ruby codes</b>
 
 
 == Features
@@ -10,14 +10,30 @@
 * Granular statistics
 * Thread-safe
 
-
+== Example
+
+    require 'benelux'
+
+    # Similar to Benchmark::Tms with the addition of
+    # standard deviation, mean value, and total, for 
+    # each of the times.
+    tms = Benelux.bm(1000000, 5) do
+      rand
+    end
+    
+    tms.samples              # => 5
+    tms.real                 # => 0.45
+    tms.real.sd              # => 0.04
+    tms.utime                # => 0.44
+    tms.utime.sd             # => 0.02
+    
 == Installation
 
 Get it in one of the following ways:
 
-     $ gem install benelux
+     $ gem install benelux --source http://gemcutter.org
+     $ sudo gem install benelux --source http://gemcutter.org
      $ git clone git://github.com/delano/benelux.git
-     $ gem install delano-benelux --source http://gems.github.com
 
 
 == More Information
@@ -25,7 +41,6 @@ Get it in one of the following ways:
 * Codes[http://github.com/delano/benelux]
 * RDocs[http://delano.github.com/benelux]
 
-
 == Credits
 
 * Delano Mandelbaum (http://solutious.com)

data/benelux.gemspec

@@ -1,8 +1,8 @@
 @spec = Gem::Specification.new do |s|
   s.name = "benelux"
   s.rubyforge_project = 'benelux'
-  s.version = "0.5.4"
-  s.summary = "Benelux: A mad timeline for Ruby codes"
+  s.version = "0.5.5"
+  s.summary = "Benelux: A mad way to time Ruby codes"
   s.description = s.summary
   s.author = "Delano Mandelbaum"
   s.email = "delano@solutious.com"

data/lib/benelux.rb

@@ -5,7 +5,7 @@ require 'thwait'
 require 'selectable'
 
 module Benelux
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
   NOTSUPPORTED = [Class, Object, Kernel]
   
   class BeneluxError < RuntimeError; end
@@ -161,7 +161,66 @@ module Benelux
   def Benelux.disable_debug; @@debug = false; end
   def Benelux.debug?; @@debug; end
   
-  
+  # Similar to Benchmark::Tms with the addition of
+  # standard deviation, mean, and total, for each of 
+  # the data times. 
+  #
+  #     tms = Benelux::Tms.new
+  #     tms.real.sd       # standard deviation
+  #     tms.utime.mean    # mean value
+  #     tms.total.n       # number of data points
+  # 
+  # See Benelux::Stats::Calculator
+  #
+  class Tms < Struct.new :label, :real, :cstime, :cutime, :stime, :utime, :total
+    attr_reader :samples
+    # +tms+ is a Benchmark::Tms object
+    def initialize tms=nil
+      @samples = 0
+      members.each_with_index { |n, index| 
+        next if n.to_s == 'label'
+        self.send("#{n}=", Stats::Calculator.new)
+      }
+      sample tms unless tms.nil?
+    end
+    def sample(tms)
+      @samples += 1
+      self.label ||= tms.label
+      members.each_with_index { |n, index| 
+        next if n.to_s == 'label'
+        self.send(n).sample tms.send(n) || 0
+      }
+    end
+    def to_s
+      total.mean
+    end
+    def inspect
+      fields = members.collect { |f| 
+        next unless Stats::Calculator === self.send(f)
+        '%s=%.2f@%.2f' % [f, self.send(f).mean, self.send(f).sd] 
+      }.compact
+      args = [self.class.to_s, self.hexoid, samples, fields.join(' ')]
+      '#<%s:%s samples=%d %s>' % args
+    end
+  end
+    
+  # Run a benchmark the healthy way: with a warmup run, with
+  # multiple repetitions, and standard deviation. 
+  # 
+  # * +n+ Number of times to execute +blk+ (one data sample)
+  # * +reps+ Number of data samples to collect
+  # * +blk+ a Ruby block to benchmark
+  #
+  # Returns a Benelux::Tms object
+  def Benelux.bm(n=1, reps=5, &blk) 
+    require 'benchmark'
+    n.times &blk
+    tms = Benelux::Tms.new
+    reps.times do |rep|
+      tms.sample Benchmark.measure() {n.times &blk}
+    end
+    tms
+  end
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: benelux
 version: !ruby/object:Gem::Version 
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-13 00:00:00 -05:00
+date: 2010-01-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: "Benelux: A mad timeline for Ruby codes"
+description: "Benelux: A mad way to time Ruby codes"
 email: delano@solutious.com
 executables: []
 
@@ -68,7 +68,7 @@ post_install_message:
 rdoc_options: 
 - --line-numbers
 - --title
-- "Benelux: A mad timeline for Ruby codes"
+- "Benelux: A mad way to time Ruby codes"
 - --main
 - README.rdoc
 require_paths: 
@@ -91,6 +91,6 @@ rubyforge_project: benelux
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: "Benelux: A mad timeline for Ruby codes"
+summary: "Benelux: A mad way to time Ruby codes"
 test_files: []