mathstats 0.9.1 → 0.9.2

data/README.txt

@@ -8,20 +8,25 @@ Mathstats is a simple statistics library.
 2. No dependencies
 3. Rails integration
 4. Usable as a mixin:   [4,8,15,16,23,42].variance
-5. Usable as a library: Mathstats::Lib.variance([4,8,15,16,23,42])
+5. Usable as a library: Mathstats.variance([4,8,15,16,23,42])
 
 == Installation
 
-$ gem sources -a http://gems.github.com
-$ gem install bmarini-mathstats
+$ gem install mathstats
 
 == Usage
 
-require 'rubygems'
 require 'mathstats'
 
-Array.send :include, Mathstats
+Mathstats.attach_to(Array) # => Array.send :include, Mathstats::Mixin
 [4,8,15,16,23,42].variance
 
 # Or if you don't want to mess with the Array class
-Mathstats::Lib.variance([4,8,15,16,23,42])
+Mathstats.variance([4,8,15,16,23,42])
+
+== Methods available
+
+* mean, average
+* standard_deviation
+* sum
+* variance

data/Rakefile

@@ -1,9 +1,3 @@
-begin
-  require 'rubygems'
-rescue Exception
-  nil
-end
-
 require 'rake/clean'
 require 'rake/testtask'
 

data/lib/mathstats.rb

@@ -1,42 +1,22 @@
-module Mathstats
-  def mean(identity = 0, &block)
-    Lib.average(self, identity, &block)
-  end
-  alias_method :average, :mean
-  
-  def standard_deviation(options = {}, &block)
-    Lib.standard_deviation(self, options, &block)
-  end
-  
-  def sum(identity = 0, &block)
-    Lib.sum(self, identity, &block)
-  end
-  
-  def variance(options = {}, &block)
-    Lib.variance(self, options, &block)
-  end
-  
-  class Lib
-    
-    def self.mean(array, identity = 0, &block)
+class Mathstats
+  class << self
+    def mean(array, identity = 0, &block)
       array.size > 0 ? sum(array, identity, &block) / array.size.to_f : identity
     end
-    
-    # Poor man's alias_method until I figure out how to do this right
-    def self.average(array, identity = 0, &block); mean(array, identity, &block); end
-    
-    def self.standard_deviation(array, options = {}, &block)
+    alias_method :average, :mean
+
+    def standard_deviation(array, options = {}, &block)
       options = {:default => 0}.merge(options)
       return options[:default] unless array.size > 0
-      
+
       if block_given?
         return standard_deviation( array.map(&block), options )
       end
-      
+
       Math.sqrt( variance(array, options) )
     end
-    
-    def self.sum(array, identity = 0, &block)
+
+    def sum(array, identity = 0, &block)
       return identity unless array.size > 0
 
       if block_given?
@@ -48,23 +28,44 @@ module Mathstats
 
     # Two pass algorithm is currently the only algo supported
     # http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance
-    def self.variance(array, options = {}, &block)
+    def variance(array, options = {}, &block)
       options = {:default => 0, :algo => :two_pass, :population => :infinite}.merge(options)
       return options[:default] unless array.size > 0
-      
+
       if block_given?
         return variance( array.map(&block), options )
       end
-      
+
       variance_two_pass(array, options)
     end
-    
-    def self.variance_two_pass(array, options)
+
+    def variance_two_pass(array, options)
       n        = array.size
       denom    = options[:population] == :infinite ? n - 1 : n
       mean     = mean(array)
       variance = array.inject(0) {|memo, element| memo + (element - mean)**2 } / denom
     end
 
+    def attach_to(klass)
+      klass.send :include, Mixin
+    end
+  end
+
+  # All the class methods from Mathstats above are available in the Mixin
+  # module, via delegation. This module can be included in any class that
+  # has a method `#to_a` like Array
+
+  module Mixin
+    def self.delegate_to_mathstats(*symbols)
+      Array(symbols).each do |symbol|
+        class_eval <<-EOS, __FILE__, __LINE__ + 1
+          def #{symbol}(*args, &block)
+            Mathstats.#{symbol}(self.to_a, *args, &block)
+          end
+        EOS
+      end
+    end
+
+    delegate_to_mathstats :mean, :average, :standard_deviation, :sum, :variance
   end
-end
+end

data/mathstats.gemspec

@@ -1,20 +1,22 @@
 Gem::Specification.new do |s|
   s.name             = "mathstats"
-  s.version          = "0.9.1"
-  s.date             = "2008-11-07"
-  s.summary          = "Basic statistics methods for ruby available as a mixin or standalone class"
+  s.version          = "0.9.2"
+  s.date             = "2010-03-20"
+  s.summary          = "Basic statistics methods for ruby available as a \
+mixin or standalone class"
   s.email            = "bmarini@gmail.com"
   s.homepage         = "http://github.com/bmarini/mathstats"
-  s.description      = "Mathstats is a basic statistics library. It is meant to be mixed into Array, but you can also use it as a standalone class."
+  s.description      = "Mathstats is a basic statistics library. It is meant \
+to be mixed into Array, but you can also use it as a standalone class."
   s.has_rdoc         = true
   s.rdoc_options     = ["--main", "README.txt"]
   s.authors          = ["Ben Marini"]
   s.files            = [
-		"README.txt", 
-		"Rakefile", 
-		"mathstats.gemspec", 
-		"lib/mathstats.rb"
-	]
+    "README.txt",
+    "Rakefile",
+    "mathstats.gemspec",
+    "lib/mathstats.rb"
+  ]
   s.test_files       = ["test/mathstats_test.rb"]
   s.extra_rdoc_files = ["README.txt"]
 end

data/test/mathstats_test.rb

@@ -1,30 +1,28 @@
 require 'test/unit'
 require 'mathstats'
 
-class TC_MyTest < Test::Unit::TestCase
-  def setup
-    Array.send :include, Mathstats
-  end
-  
+class MathStatsTest < Test::Unit::TestCase
   def test_average_as_module
+    Mathstats.attach_to(Array)
     assert_equal 3, [1,2,3,4,5].average
     assert_equal(6, [1,2,3,4,5].average {|n| n * 2 })
     assert_equal(0, [].average(0))
     assert_equal('empty', [].average('empty'))
-    
+
     assert_equal(1.5, [1,2].average)
   end
-  
+
   def test_average_as_class
-    assert_equal 3, Mathstats::Lib.average([1,2,3,4,5])
-    assert_equal(6, Mathstats::Lib.average([1,2,3,4,5]) {|n| n * 2 })
-    assert_equal(0, Mathstats::Lib.average([], 0))
-    assert_equal('empty', Mathstats::Lib.average([], 'empty'))
-    
-    assert_equal(1.5, Mathstats::Lib.average([1,2]))
+    assert_equal 3, Mathstats.average([1,2,3,4,5])
+    assert_equal(6, Mathstats.average([1,2,3,4,5]) {|n| n * 2 })
+    assert_equal(0, Mathstats.average([], 0))
+    assert_equal('empty', Mathstats.average([], 'empty'))
+
+    assert_equal(1.5, Mathstats.average([1,2]))
   end
 
   def test_sum_as_module
+    Mathstats.attach_to(Array)
     assert_equal 10, [1,2,3,4].sum
     assert_equal(20, [1,2,3,4].sum {|n| n * 2 })
     assert_equal(0, [].sum(0))
@@ -32,37 +30,31 @@ class TC_MyTest < Test::Unit::TestCase
   end
 
   def test_sum_as_class
-    assert_equal 15, Mathstats::Lib.sum([1,2,3,4,5])
-    assert_equal(30, Mathstats::Lib.sum([1,2,3,4,5]) {|n| n * 2 })
-    assert_equal(0, Mathstats::Lib.sum([], 0))
-    assert_equal('empty', Mathstats::Lib.sum([], 'empty'))
-    
-    assert_equal(3, Mathstats::Lib.sum([1,2]))
+    assert_equal 15, Mathstats.sum([1,2,3,4,5])
+    assert_equal(30, Mathstats.sum([1,2,3,4,5]) {|n| n * 2 })
+    assert_equal(0, Mathstats.sum([], 0))
+    assert_equal('empty', Mathstats.sum([], 'empty'))
+
+    assert_equal(3, Mathstats.sum([1,2]))
   end
-  
+
   def test_variance_as_module
+    Mathstats.attach_to(Array)
     assert_equal 30, [4, 7, 13, 16].variance
     assert_equal 30, [4, 7, 13, 16].map {|n| 10**8 + n }.variance
     assert_equal 30, [4, 7, 13, 16].map {|n| 10**9 + n }.variance
   end
 
   def test_variance_as_class
-    assert_equal 30, Mathstats::Lib.variance([4, 7, 13, 16])
-    assert_equal 30, Mathstats::Lib.variance([4, 7, 13, 16].map {|n| 10**8 + n })
-    assert_equal 30, Mathstats::Lib.variance([4, 7, 13, 16].map {|n| 10**9 + n })
+    assert_equal 30, Mathstats.variance([4, 7, 13, 16])
+    assert_equal 30, Mathstats.variance([4, 7, 13, 16].map {|n| 10**8 + n })
+    assert_equal 30, Mathstats.variance([4, 7, 13, 16].map {|n| 10**9 + n })
   end
-  
+
   def test_standard_deviation_as_module
+    Mathstats.attach_to(Array)
     assert_equal 6, [3,7,7,19].standard_deviation({:population => :finite})
     assert_equal 6.93, ([3,7,7,19].standard_deviation * 100).round / 100.0
   end
 
-  def test_standard_deviation_as_class
-    assert_equal 6, Mathstats::Lib.standard_deviation([3,7,7,19], {:population => :finite})
-    assert_equal 6.93,  ( Mathstats::Lib.standard_deviation([3,7,7,19]) * 100 ).round / 100.0
-  end
-
-  # def teardown
-  # end
-
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mathstats
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 2
+  version: 0.9.2
 platform: ruby
 authors: 
 - Ben Marini
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-07 00:00:00 -08:00
+date: 2010-03-20 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -40,18 +45,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Basic statistics methods for ruby available as a mixin or standalone class