bkoski-array_stats 0.5.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-01-21
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/array_stats.rb
+lib/array_stats/array_stats.rb
+lib/array_stats/array.rb
+lib/array_stats/float.rb
+script/console
+script/destroy
+script/generate
+test/test_array_stats.rb
+test/test_float_extensions.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1 @@
+For more information on array_stats, see http://github.com/bkoski/array_stats

data/README.rdoc

@@ -0,0 +1,67 @@
+= array_stats
+
+* http://github.com/bkoski/array_stats
+
+== DESCRIPTION:
+
+Simple statistics for ruby arrays -- mean, median, sum, and percentile.  For more complex
+applications, you should consider NArray[http://narray.rubyforge.org/].
+
+== SYNOPSIS:
+
+Adds convenient methods to grab stats from a Ruby array, including:
+* mean
+* median
+* sum
+* percentile
+
+Percentile calculations are based on the NIST formula[http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm] for percentiles.
+
+== EXAMPLE:
+
+  require 'array_stats'
+  
+  puts [1,3,5,7].mean
+  > 4
+  
+  puts [1,2,3,4].sum
+  > 10
+  
+  puts [1,2,3,4,5].median
+  > 3
+  
+  puts [1,2,3,4,5].percentile(50)
+  > 3
+   
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* <tt>sudo gem install bkoski-array_stats --source http://gems.github.com</tt>
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Ben Koski
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/array_stats'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('array_stats', ArrayStats::VERSION) do |p|
+  p.developer('Ben Koski', 'gems@benkoski.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  # p.extra_dev_deps = [
+  #   ['newgem', ">= #{::Newgem::VERSION}"]
+  # ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/array_stats.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module ArrayStats
+  VERSION = '0.5.0'
+end
+
+require "#{File.dirname(__FILE__)}/array_stats/float"
+require "#{File.dirname(__FILE__)}/array_stats/array_stats"
+require "#{File.dirname(__FILE__)}/array_stats/array"
+

data/lib/array_stats/array.rb

@@ -0,0 +1,3 @@
+class Array
+  include ArrayStats
+end

data/lib/array_stats/array_stats.rb

@@ -0,0 +1,43 @@
+module ArrayStats
+  
+  # Returns the sum of all elements in the array; 0 if array is empty
+  def sum
+    self.inject(0) {|sum, sample| sum += sample}
+  end
+  
+  # Returns the mean of all elements in array; nil if array is empty
+  def mean
+    if self.length == 0
+      nil
+    else
+      self.sum / self.length
+    end
+  end
+
+  # Returns the median for the array; nil if array is empty
+  def median
+    percentile(50)
+  end
+  
+  # Returns the percentile value for percentile _p_; nil if array is empty.
+  #
+  # _p_ should be expressed as an integer; <tt>percentile(90)</tt> returns the 90th percentile of the array.
+  #
+  # Algorithm from NIST[http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm]
+  def percentile p
+    sorted_array = self.sort
+    rank = (p.to_f / 100) * (self.length + 1)
+    
+    if self.length == 0
+      return nil
+    elsif rank.fractional_part?
+      sample_0 = sorted_array[rank.truncate - 1]
+      sample_1 = sorted_array[rank.truncate]
+
+      return (rank.fractional_part * (sample_1 - sample_0)) + sample_0
+    else
+      return sorted_array[rank - 1]
+    end    
+  end
+  
+end

data/lib/array_stats/float.rb

@@ -0,0 +1,13 @@
+class Float
+  
+  # Returns true if a float has a fractional part; i.e. <tt>f == f.to_i</tt>
+  def fractional_part?
+    fractional_part != 0.0
+  end
+  
+  # Returns the fractional part of a float. For example, <tt>(6.67).fractional_part == 0.67</tt>
+  def fractional_part
+    (self - self.truncate).abs
+  end
+  
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/array_stats.rb'}"
+puts "Loading array_stats gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_array_stats.rb

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestArrayStats < Test::Unit::TestCase
+
+  context "median" do
+    should "return the middle of the set if array length is odd" do
+      assert_equal 15, [1,2,15,22,38].median
+    end
+    
+    should "return the average of the middle of the set if array length is even" do
+      assert_equal 10, [1,6,14,22].median
+    end
+    
+    should "return nil if the array is empty" do
+      assert_nil [].median
+    end
+    
+    should "sort an array before deriving the median" do
+      assert_equal 20, [1,20,50,60,10].median
+    end
+  end
+  
+  context "percentile" do 
+    should "choose the number at a particular rank if array divides cleanly" do
+      assert_equal 36, [12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48].percentile(65)
+    end
+    
+    should "interpolate according to algorithm if array does not divide cleanly" do
+      assert_equal 5.5, [3,5,7,8,9,11,13,15].percentile(25)
+      assert_equal 95.1981, [95.1772,95.1567,95.1937,95.1959,95.1442,95.0610,95.1591,95.1195,95.1065,95.0925,95.1990,95.1682].percentile(90).round_to(0.0001)
+    end
+    
+    should "return nil if the array is empty" do
+      assert_nil [].percentile(30)
+    end
+  end
+  
+  context "sum" do
+    should "return the sum of all elements in the array" do
+      assert_equal 12, [2,4,6].sum
+    end
+    
+    should "return an integer if all elements are ints" do
+      assert_kind_of Integer, [2,4,6].sum
+    end
+    
+    should "return a float if at least some of the elements are floats" do
+      assert_kind_of Float, [2.5,3.5,6].sum
+    end
+    
+    should "return 0 if the array is empty" do
+      assert_equal 0, [].sum
+    end
+  end
+  
+  context "mean" do
+    should "return the mean for the array " do
+      assert_equal 7, [2,4,6,8,10,12].mean
+      assert_equal 25, [48,29,26,19,3].mean
+    end
+    
+    should "return nil if the array is empty" do
+      assert_nil [].mean
+    end
+  end
+  
+  
+  
+end
+
+

data/test/test_float_extensions.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestFloatExtensions < Test::Unit::TestCase
+
+  context "fractional_part?" do
+    should "return true for a number with a fractional part" do
+      n = 1.249
+      assert n.fractional_part?
+    end
+    
+    should "return true for a number without a fractional part" do
+       n = 1.0
+       assert !n.fractional_part?
+     end
+  end
+  
+  context "fractional_part" do
+    should "return the decimal parts for a number" do
+      n = 12.2456
+      assert_in_delta 0.2456, n.fractional_part, 0.00000001
+    end
+    
+    should "retrun the decimal parts, even if they are 0" do
+      n = 12.0
+      assert_equal 0.0, n.fractional_part
+    end
+    
+    should "retrun the decimal as a positive number, even if the original float is negative" do
+      n = -12.2399
+      assert_in_delta 0.2399, n.fractional_part, 0.00000001
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/array_stats'
+require 'shoulda'
+require 'facets'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: bkoski-array_stats
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Ben Koski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Simple statistics for ruby arrays -- mean, median, sum, and percentile.  For more complex applications, you should consider NArray[http://narray.rubyforge.org/].
+email: 
+- gems@benkoski.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/array_stats.rb
+- lib/array_stats/array_stats.rb
+- lib/array_stats/array.rb
+- lib/array_stats/float.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_array_stats.rb
+- test/test_float_extensions.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bkoski/array_stats
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: array_stats
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple statistics for ruby arrays -- mean, median, sum, and percentile
+test_files: 
+- test/test_array_stats.rb
+- test/test_float_extensions.rb
+- test/test_helper.rb