bmarini-mathstats 0.9.1

data/README.txt

@@ -0,0 +1,27 @@
+= Mathstats
+
+Mathstats is a simple statistics library.
+
+== Goals
+
+1. Support for basic statistics equations
+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])
+
+== Installation
+
+$ gem sources -a http://gems.github.com
+$ gem install bmarini-mathstats
+
+== Usage
+
+require 'rubygems'
+require 'bmarini-mathstats'
+
+Array.send :include, Mathstats
+[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])

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'rubygems'
+rescue Exception
+  nil
+end
+
+require 'rake/clean'
+require 'rake/testtask'
+
+task :default => [:test]
+
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.pattern = 'test/*_test.rb'
+    t.verbose = true
+  end
+end

data/lib/mathstats.rb

@@ -0,0 +1,70 @@
+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)
+      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)
+      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)
+      return identity unless array.size > 0
+
+      if block_given?
+        sum( array.map(&block) )
+      else
+        array.inject { |sum, element| sum + element }
+      end
+    end
+
+    # Two pass algorithm is currently the only algo supported
+    # http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance
+    def self.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)
+      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
+
+  end
+end

data/mathstats.gemspec

@@ -0,0 +1,20 @@
+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.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.has_rdoc         = true
+  s.rdoc_options     = ["--main", "README.txt"]
+  s.authors          = ["Ben Marini"]
+  s.files            = [
+		"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

@@ -0,0 +1,63 @@
+require 'test/unit'
+require 'mathstats'
+
+class TC_MyTest < Test::Unit::TestCase
+  def setup
+    Array.send :include, Mathstats
+  end
+  
+  def test_average_as_module
+    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]))
+  end
+
+  def test_sum_as_module
+    assert_equal 10, [1,2,3,4].sum
+    assert_equal(20, [1,2,3,4].sum {|n| n * 2 })
+    assert_equal(0, [].sum(0))
+    assert_equal('empty', [].sum('empty'))
+  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]))
+  end
+  
+  def test_variance_as_module
+    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 })
+  end
+  
+  def test_standard_deviation_as_module
+    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 teardown
+  # end
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: bmarini-mathstats
+version: !ruby/object:Gem::Version 
+  version: 0.9.1
+platform: ruby
+authors: 
+- Ben Marini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-07 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+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.
+email: bmarini@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- README.txt
+- Rakefile
+- mathstats.gemspec
+- lib/mathstats.rb
+has_rdoc: true
+homepage: http://github.com/bmarini/mathstats
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Basic statistics methods for ruby available as a mixin or standalone class
+test_files: 
+- test/mathstats_test.rb