array_stats 0.6.0

data/README.rdoc

@@ -0,0 +1,64 @@
+= array_stats
+
+* Docs[http://benkoski.com/array_stats/]
+* Source[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 (named total_sum to avoid ActiveRecord conflicts)
+* 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].total_sum
+  > 10
+  
+  puts [1,2,3,4,5].median
+  > 3
+  
+  puts [1,2,3,4,5].percentile(50)
+  > 3
+   
+== INSTALL:
+
+* <tt>sudo gem install bkoski-array_stats --source http://gemcutter.org</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,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "array_stats"
+    gem.summary = %Q{Easy mean, median, percentile, and sum statistics for Ruby Arrays}
+    gem.description = %Q{Easy mean, median, percentile, and sum statistics for Ruby Arrays}
+    gem.email = "gems@benkoski.com"
+    gem.homepage = "http://github.com/bkoski/array_stats"
+    gem.authors = ["Ben Koski"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "array_stats #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.6.0

data/array_stats.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{array_stats}
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Koski"]
+  s.date = %q{2010-04-05}
+  s.description = %q{Easy mean, median, percentile, and sum statistics for Ruby Arrays}
+  s.email = %q{gems@benkoski.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "array_stats.gemspec",
+     "lib/array_stats.rb",
+     "lib/array_stats/array.rb",
+     "lib/array_stats/array_stats.rb",
+     "lib/array_stats/float.rb",
+     "test/test_array_stats.rb",
+     "test/test_float_extensions.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bkoski/array_stats}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Easy mean, median, percentile, and sum statistics for Ruby Arrays}
+  s.test_files = [
+    "test/test_array_stats.rb",
+     "test/test_float_extensions.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

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 total_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.total_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/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 "total_sum" do
+    should "return the sum of all elements in the array" do
+      assert_equal 12, [2,4,6].total_sum
+    end
+    
+    should "return an integer if all elements are ints" do
+      assert_kind_of Integer, [2,4,6].total_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].total_sum
+    end
+    
+    should "return 0 if the array is empty" do
+      assert_equal 0, [].total_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,76 @@
+--- !ruby/object:Gem::Specification 
+name: array_stats
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- Ben Koski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Easy mean, median, percentile, and sum statistics for Ruby Arrays
+email: gems@benkoski.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- array_stats.gemspec
+- lib/array_stats.rb
+- lib/array_stats/array.rb
+- lib/array_stats/array_stats.rb
+- lib/array_stats/float.rb
+- test/test_array_stats.rb
+- test/test_float_extensions.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bkoski/array_stats
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Easy mean, median, percentile, and sum statistics for Ruby Arrays
+test_files: 
+- test/test_array_stats.rb
+- test/test_float_extensions.rb
+- test/test_helper.rb