simple_stats 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode # currently in active development, may or may not work for your project
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in simple_stats.gemspec
+gemspec
+
+gem 'rspec'

data/README.md

@@ -0,0 +1,109 @@
+# SimpleStats [![Build Status](https://secure.travis-ci.org/brianhempel/simple_stats.png)](http://travis-ci.org/brianhempel/simple_stats)
+
+
+Install without Bundler:
+
+    gem install simple_stats --no-ri --no-rdoc
+
+Install with Bundler:
+
+```ruby
+gem "simple_stats"
+```
+
+Then get some statistics on arrays or enumerables:
+
+```ruby
+require 'rubygems' # if not using Bundler
+require 'simple_stats'
+
+samples = [3, 1, 0, 8, 2, 2, 3, 9]
+
+samples.sum    # 28 
+samples.mean   # 3.5 
+samples.median # 2.5 
+samples.modes  # [2, 3] 
+samples.frequencies
+# {
+#   0 => 1,
+#   1 => 1,
+#   2 => 2,
+#   3 => 2,
+#   8 => 1,
+#   9 => 1
+# }
+samples.sorted_frequencies
+# most common elements first
+# [
+#   [2, 2],
+#   [3, 2],
+#   [0, 1],
+#   [1, 1],
+#   [8, 1],
+#   [9, 1]
+# ]
+
+# of course, you can take modes/frequencies on non-numeric data...
+"banana nanny!".chars.modes
+# ["n"]
+"banana nanny!".chars.frequencies
+# {
+#   " " => 1,
+#   "! "=> 1,
+#   "a" => 4,
+#   "b" => 1,
+#   "n" => 5,
+#   "y" => 1
+# }
+"banana nanny!".chars.sorted_frequencies
+# [
+#   ["n", 5],
+#   ["a", 4],
+#   [" ", 1],
+#   ["!", 1],
+#   ["b", 1],
+#   ["y", 1]
+# ]
+
+# sum of nothing is 0
+[].sum # 0
+
+# mean and median of nothing is undefined
+[].mean   # nil
+[].median # nil
+
+# modes and frequencies return empty containers
+[].modes              # []
+[].frequencies        # {}
+[].sorted_frequencies # []
+
+# if elements are preset, mean and median always return floats
+[1, 2, 3].mean      # 2.0
+[1, 2, 3].median    # 2.0
+[1, 2, 3, 4].mean   # 2.5
+[1, 2, 3, 4].median # 2.5
+
+# sum, mode, and frequencies preserve the object class
+[1, 2, 3].sum       # 6
+[1.0, 2.0, 3.0].sum # 6.0
+
+# but no guarantees on class here:
+[2.0, 2,   1].modes # [2]
+[2,   2.0, 1].modes # [2.0]
+```
+
+## Help make it better!
+
+Need something added? [Open an issue](https://github.com/brianhempel/simple_stats/issues). Or, even better, code it yourself and send a pull request:
+
+    # fork it on github, then clone:
+    git clone git@github.com:your_username/simple_stats.git
+    bundle install
+    rspec
+    # hack away
+    git push
+    # then make a pull request
+
+## License
+
+Public domain. (I, Brian Hempel, the original author release this code to the public domain.)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simple_stats/core_ext/enumerable.rb

@@ -0,0 +1,66 @@
+module Enumerable
+  def sum
+    inject(0) { |sum, x| sum + x }
+  end
+
+  def mean
+    count = self.count # count has to iterate if there's no size method
+    return nil if count == 0
+    sum / count.to_f
+  end
+
+  def median
+    sorted = sort
+    count  = sorted.size
+    i      = count / 2
+
+    return nil if count == 0
+    if count % 2 == 1
+      sorted[i].to_f
+    else
+      ( sorted[i-1] + sorted[i] ) / 2.0
+    end
+  end
+
+  def modes
+    sorted_frequencies = self.sorted_frequencies
+    sorted_frequencies.select do |item, frequency|
+      frequency == sorted_frequencies.first[1]
+    end.map do |item, frequency|
+      item
+    end
+  end
+
+  def frequencies
+    begin
+      sorted = sort
+    rescue NoMethodError # i.e. undefined method `<=>' for :my_symbol:Symbol
+      sorted = sort_by do |item|
+        item.respond_to?(:"<=>") ? item : item.to_s
+      end
+    end
+    current_item = nil;
+
+    Hash[
+      sorted.reduce([]) do |frequencies, item|
+        if frequencies.size == 0 || item != current_item
+          current_item = item
+          frequencies << [item, 1]
+        else
+          frequencies.last[1] += 1
+          frequencies
+        end
+      end
+    ]
+  end
+
+  def sorted_frequencies
+    frequencies.sort_by do |item, frequency|
+      if item.respond_to?(:"<=>")
+        [-frequency, item]
+      else
+        [-frequency, item.to_s]
+      end
+    end
+  end
+end

data/lib/simple_stats/version.rb

@@ -0,0 +1,3 @@
+module SimpleStats
+  VERSION = "1.0.0"
+end

data/lib/simple_stats.rb

@@ -0,0 +1,2 @@
+require "simple_stats/version"
+require "simple_stats/core_ext/enumerable"

data/simple_stats.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_stats/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_stats"
+  s.version     = SimpleStats::VERSION
+  s.authors     = ["Brian Hempel"]
+  s.email       = ["plasticchicken@gmail.com"]
+  s.homepage    = "https://github.com/brianhempel/simple_stats"
+  s.summary     = "Simple mean, median, modes, sum, and frequencies for Ruby arrays and enumerables. Tested and sensible."
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/spec/enumerable/frequencies_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+frequencies_expectations = {
+  []                       => {},
+  [1]                      => { 1 => 1 },
+  [1.0]                    => { 1.0 => 1 },
+  [1, -1]                  => { -1 => 1, 1 => 1 },
+  [3, 1, 3]                => { 3 => 2, 1 => 1 },
+  [3, 1, 3.0]              => { 3 => 2, 1 => 1 },
+  [3.0, 1, 3]              => { 3.0 => 2, 1 => 1 },
+  (0...0)                  => {},
+  (1..1)                   => { 1 => 1 },
+  (0..3)                   => { 0 => 1, 1 => 1, 2 => 1, 3 => 1 },
+  [BigDecimal("0.0")]      => { BigDecimal("0.0") => 1 },
+  [-2, BigDecimal("1.0")]  => { -2 => 1, BigDecimal("1.0") => 1 },
+  [:b, :c, :b, :c, :c, :a] => { :c => 3, :b => 2, :a => 1 }
+}
+
+describe Enumerable do
+  describe "#frequencies" do
+    frequencies_expectations.each do |data, expected|
+      it "is #{expected.inspect} for #{data.inspect}" do
+        frequencies = data.frequencies
+        frequencies.should       == expected
+        frequencies.class.should == expected.class
+      end
+    end
+  end
+end

data/spec/enumerable/mean_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+mean_expectations = {
+  []                      => nil,
+  [1]                     => 1.0,
+  [1.0]                   => 1.0,
+  [1, -1]                 => 0.0,
+  [1, 2, 3]               => 2.0,
+  [1, 2, 3.0]             => 2.0,
+  [2, 2, 3.0]             => 7.0 / 3.0,
+  (0...0)                 => nil,
+  (1..1)                  => 1.0,
+  (0..3)                  => 1.5,
+  [BigDecimal("0.0")]     => 0.0,
+  [-2, BigDecimal("1.0")] => -0.5
+}
+
+describe Enumerable do
+  describe "#mean" do
+    mean_expectations.each do |data, expected|
+      it "is #{expected.inspect} for #{data.inspect}" do
+        mean = data.mean
+        mean.should       == expected
+        mean.class.should == expected.class
+      end
+    end
+  end
+end

data/spec/enumerable/median_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+median_expectations = {
+  []                      => nil,
+  [1]                     => 1.0,
+  [1.0]                   => 1.0,
+  [1, -1]                 => 0.0,
+  [1, 2, 3000]            => 2.0,
+  [1, 2, 3000.0]          => 2.0,
+  [2, 2, 3000.0]          => 2.0,
+  (0...0)                 => nil,
+  (1..1)                  => 1.0,
+  (0..3)                  => 1.5,
+  [BigDecimal("0.0")]     => 0.0,
+  [-2, BigDecimal("1.0")] => -0.5
+}
+
+describe Enumerable do
+  describe "#median" do
+    median_expectations.each do |data, expected|
+      it "is #{expected.inspect} for #{data.inspect}" do
+        median = data.median
+        median.should       == expected
+        median.class.should == expected.class
+      end
+    end
+  end
+end

data/spec/enumerable/modes_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+modes_expectations = {
+  []                                          => [],
+  [1]                                         => [1],
+  [1.0]                                       => [1.0],
+  [1, -1]                                     => [-1, 1],
+  [3, 1, 3]                                   => [3],
+  [3, 1, 3.0]                                 => [3],
+  [3.0, 1, 3]                                 => [3.0],
+  (0...0)                                     => [],
+  (1..1)                                      => [1],
+  (0..3)                                      => [0, 1, 2, 3],
+  [BigDecimal("0.0")]                         => [BigDecimal("0.0")],
+  [BigDecimal("1.0"), -2, BigDecimal("1.0")]  => [BigDecimal("1.0")],
+  [:b, :c, :b, :c, :c, :a]                    => [:c]
+}
+
+describe Enumerable do
+  describe "#modes" do
+    modes_expectations.each do |data, expected|
+      it "is #{expected.inspect} for #{data.inspect}" do
+        modes = data.modes
+        modes.should       == expected
+        modes.class.should == expected.class
+      end
+    end
+  end
+end

data/spec/enumerable/sorted_frequencies_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Enumerable do
+  describe "#sorted_frequencies" do
+    it "returns #frequencies sorted by [frequency, value]" do
+      enumerable = (0...0)
+      enumerable.stub(:frequencies) do
+        {
+          "White-breasted Nuthatch" => 1,
+          "Red-breasted Nuthatch"   => 1,
+          "Brown Creeper"           => 1,
+          "Squirrel"                => 1,
+          "Marmelade"               => 1000,
+          :yeah                     => 3,
+          :man                      => 3,
+          11                        => 12
+        }
+      end
+
+      enumerable.sorted_frequencies.should == [
+        ["Marmelade", 1000],
+        [11, 12],
+        [:man, 3],
+        [:yeah, 3],
+        ["Brown Creeper", 1],
+        ["Red-breasted Nuthatch", 1],
+        ["Squirrel", 1],
+        ["White-breasted Nuthatch", 1]
+      ]
+    end
+  end
+end

data/spec/enumerable/sum_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+sum_expectations = {
+  []                     => 0, # see http://en.wikipedia.org/wiki/Empty_sum
+  [1]                    => 1,
+  [1.0]                  => 1.0,
+  [1, -1]                => 0,
+  [1, 2, 3]              => 6,
+  [1, 2, 3.0]            => 6.0,
+  (0...0)                => 0, # see http://en.wikipedia.org/wiki/Empty_sum
+  (1..1)                 => 1,
+  (0..3)                 => 6,
+  [BigDecimal("0.0")]    => BigDecimal("0.0"),
+  [3, BigDecimal("1.0")] => BigDecimal("4.0")
+}
+
+describe Enumerable do
+  describe "#sum" do
+    sum_expectations.each do |data, expected|
+      it "is #{expected.inspect} for #{data.inspect}" do
+        sum = data.sum
+        sum.should       == expected
+        sum.class.should == expected.class
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'simple_stats'
+require 'bigdecimal'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: simple_stats
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Brian Hempel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-10 00:00:00 Z
+dependencies: []
+
+description: Simple mean, median, modes, sum, and frequencies for Ruby arrays and enumerables. Tested and sensible.
+email: 
+- plasticchicken@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/simple_stats.rb
+- lib/simple_stats/core_ext/enumerable.rb
+- lib/simple_stats/version.rb
+- simple_stats.gemspec
+- spec/enumerable/frequencies_spec.rb
+- spec/enumerable/mean_spec.rb
+- spec/enumerable/median_spec.rb
+- spec/enumerable/modes_spec.rb
+- spec/enumerable/sorted_frequencies_spec.rb
+- spec/enumerable/sum_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/brianhempel/simple_stats
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Simple mean, median, modes, sum, and frequencies for Ruby arrays and enumerables. Tested and sensible.
+test_files: 
+- spec/enumerable/frequencies_spec.rb
+- spec/enumerable/mean_spec.rb
+- spec/enumerable/median_spec.rb
+- spec/enumerable/modes_spec.rb
+- spec/enumerable/sorted_frequencies_spec.rb
+- spec/enumerable/sum_spec.rb
+- spec/spec_helper.rb