rstat 0.0.4 → 0.1.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.1.0
+
+* Major reorganization! All files now in directories named after their corresponding discipline (as sort of defined by Wikipedia).
+* Added skewness.
+* Mean methods now now use the sum method.
+* Minor reorganization of tests.
+* Changed Gemfile source to https.
+* Added index of dispersion.
+
 ## v0.0.4
 
 * Added percentile.

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in rstat.gemspec
 gemspec

data/lib/rstat.rb

@@ -2,5 +2,4 @@ require "rstat/version"
 require "rstat/core_ext"
 
 module Rstat
-  # Your code goes here...
 end

data/lib/rstat/core_ext/array/descriptive_statistics.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/descriptive_statistics/*.rb"].sort.each do |path|
+  require "rstat/core_ext/array/descriptive_statistics/#{File.basename(path, ".rb")}"
+end

data/lib/rstat/core_ext/array/descriptive_statistics/dispersion.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/dispersion/*.rb"].sort.each do |path|
+  require "rstat/core_ext/array/descriptive_statistics/dispersion/#{File.basename(path, ".rb")}"
+end

data/lib/rstat/core_ext/array/{percentile.rb → descriptive_statistics/dispersion/percentile.rb}

@@ -3,7 +3,7 @@ class Array
     if p < 0 || p > 100
       nil
     else
-      self.sort[((p.to_f/100.0) * self.length.to_f) - 0.5]
+      self.sort[((p.to_f / 100.0) * self.length.to_f) - 0.5]
     end
   end
 

data/lib/rstat/core_ext/array/{standard_deviation.rb → descriptive_statistics/dispersion/standard_deviation.rb}

@@ -1,10 +1,4 @@
 class Array
-  def variance
-    mean = self.mean
-
-    (1.0 / self.length) * self.map{|x| (x - mean) ** 2}.inject(:+)
-  end
-
   def standard_deviation
     Math.sqrt(self.variance)
   end

data/lib/rstat/core_ext/array/descriptive_statistics/index_of_dispersion.rb

@@ -0,0 +1,25 @@
+class Array
+  def index_of_dispersion
+    self.variance / self.mean
+  end
+
+  def dispersion_index
+    self.index_of_dispersion
+  end
+
+  def coefficient_of_dispersion
+    self.index_of_dispersion
+  end
+
+  def variance_to_mean_ratio
+    self.index_of_dispersion
+  end
+
+  def vmr
+    self.index_of_dispersion
+  end
+
+  def fano_factor
+    self.index_of_dispersion
+  end
+end

data/lib/rstat/core_ext/array/descriptive_statistics/location.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/location/*.rb"].sort.each do |path|
+  require "rstat/core_ext/array/descriptive_statistics/location/#{File.basename(path, ".rb")}"
+end

data/lib/rstat/core_ext/array/{mean.rb → descriptive_statistics/location/mean.rb}

@@ -12,7 +12,7 @@ class Array
   end
 
   def harmonic_mean
-    self.length / self.map{ |x| 1.0 / x }.inject{ |sum, x| sum + x }.to_f
+    self.length / self.map{ |x| 1.0 / x }.sum.to_f
   end
 
   def quadratic_mean
@@ -20,6 +20,6 @@ class Array
   end
 
   def power_mean(p = 1)
-    ((1.0 / self.length) * self.map{ |x| x ** p }.inject{ |sum, x| sum + x }.to_f) ** (1.0 / p)
+    ((1.0 / self.length) * self.map{ |x| x ** p }.sum.to_f) ** (1.0 / p)
   end
 end

data/lib/rstat/core_ext/array/{median.rb → descriptive_statistics/location/median.rb}

@@ -1,6 +1,6 @@
 class Array
   def median
-    unless self.length == 0
+    if self.length != 0
       copy = self.sort
 
       if copy.length % 2 == 0

data/lib/rstat/core_ext/array/descriptive_statistics/shape.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/shape/*.rb"].sort.each do |path|
+  require "rstat/core_ext/array/descriptive_statistics/shape/#{File.basename(path, ".rb")}"
+end

data/lib/rstat/core_ext/array/descriptive_statistics/shape/kurtosis.rb

@@ -0,0 +1,5 @@
+class Array
+  def kurtosis
+    (self.central_moment(4) / self.variance ** 2) - 3
+  end
+end

data/lib/rstat/core_ext/array/descriptive_statistics/shape/moment.rb

@@ -0,0 +1,23 @@
+class Array
+  def central_moment k
+    if k < 0
+      nil
+    else
+      mean = self.mean
+
+      (1.0 / self.length) * self.map{ |x| (x - mean) ** k }.sum
+    end
+  end
+
+  def raw_moment k
+    if k < 0
+      nil
+    else
+      (1.0 / self.length) * self.map{ |x| x ** k }.sum
+    end
+  end
+
+  # def l_moment k
+  #
+  # end
+end

data/lib/rstat/core_ext/array/descriptive_statistics/shape/skewness.rb

@@ -0,0 +1,5 @@
+class Array
+  def skewness
+    self.central_moment(3) / (self.variance ** 1.5)
+  end
+end

data/lib/rstat/core_ext/array/descriptive_statistics/shape/variance.rb

@@ -0,0 +1,5 @@
+class Array
+  def variance
+    self.central_moment 2
+  end
+end

data/lib/rstat/core_ext/fixnum.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/fixnum/*.rb"].sort.each do |path|
+  require "rstat/core_ext/fixnum/#{File.basename(path, ".rb")}"
+end

data/lib/rstat/core_ext/fixnum/binomial_coefficient.rb

@@ -0,0 +1,5 @@
+class Fixnum
+  def binomial_coefficient bottom
+    (self - bottom + 1 .. self).inject(1, &:*) / (2 .. bottom).inject(1, &:*)
+  end
+end

data/lib/rstat/version.rb

@@ -1,3 +1,3 @@
 module Rstat
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/rstat/array_spec.rb

@@ -14,114 +14,190 @@ describe Rstat do
     end
   end
 
-  describe ".range" do
-    it "finds the range of an array" do
-      [0, 34, 656, 400, 1000].range.should be(1000)
+  context "Location" do
+    describe ".mean" do
+        it "calculates the mean of an array" do
+          [1, 2, 3, 4, 5].mean.should be_within(0.0001).of(3.0000)
+        end
     end
-  end
 
-  describe ".mean" do
-      it "calculates the mean of an array" do
-        [1, 2, 3, 4, 5].mean.should be_within(0.0001).of(3.0000)
+    describe ".geometric_mean" do
+      it "calculates the geometric mean of an array" do
+        [1, 2, 3, 4, 5].geometric_mean.should be_within(0.0001).of(2.6052)
+      end
+
+      it "calculates the geometric mean of an array with a zero element" do
+        [0, 2, 3, 4, 5].geometric_mean.should eql(0.0)
       end
-  end
 
-  describe ".geometric_mean" do
-    it "calculates the geometric mean of an array" do
-      [1, 2, 3, 4, 5].geometric_mean.should be_within(0.0001).of(2.6052)
+      it "calculates the geometric mean of an array with a negative element" do
+        [-1, 2, 3, 4, 5].geometric_mean.real?.should be_false
+      end
     end
 
-    it "calculates the geometric mean of an array with a zero element" do
-      [0, 2, 3, 4, 5].geometric_mean.should eql(0.0)
+    describe ".harmonic mean" do
+      it "calculates the harmonic mean of an array" do
+        [1, 2, 3, 4, 5].harmonic_mean.should be_within(0.0001).of(2.1897)
+      end
     end
 
-    it "calculates the geometric mean of an array with a negative element" do
-      [-1, 2, 3, 4, 5].geometric_mean.real?.should be_false
+    describe ".power_mean" do
+      it "power_mean(2) should equal quadratic_mean" do
+        p = [1, 2, 3, 4, 5].power_mean(2)
+        q = [1, 2, 3, 4, 5].quadratic_mean
+
+        p.should eql(q)
+      end
     end
-  end
 
-  describe ".harmonic mean" do
-    it "calculates the harmonic mean of an array" do
-      [1, 2, 3, 4, 5].harmonic_mean.should be_within(0.0001).of(2.1897)
+    it "AM > GM > HM" do
+      a = [1, 2, 3, 4, 5]
+      am = a.arithmetric_mean
+      gm = a.geometric_mean
+      hm = a.harmonic_mean
+
+      am.should be > gm
+      gm.should be > hm
     end
-  end
 
-  describe ".power_mean" do
-    it "power_mean(2) should equal quadratic_mean" do
-      p = [1, 2, 3, 4, 5].power_mean(2)
-      q = [1, 2, 3, 4, 5].quadratic_mean
+    describe ".median" do
+      it "calculates the median of an array with an odd number of elements" do
+        [2, 3, 5, 1, 4].median.should eql(3)
+      end
 
-      p.should eql(q)
+      it "calculates the median of an array with an even number of elements" do
+        [2, 3, 5, 1, 4, 6].median.should eql(3.5)
+      end
     end
-  end
 
-  it "AM > GM > HM" do
-    a = [1, 2, 3, 4, 5]
-    am = a.arithmetric_mean
-    gm = a.geometric_mean
-    hm = a.harmonic_mean
+    describe ".mode" do
+      it "calculates the mode of an empty array" do
+        [].mode.should eql([])
+      end
 
-    am.should be > gm
-    gm.should be > hm
-  end
+      it "calculates the mode of an array with one element" do
+        [100].mode.should eql([100])
+      end
 
-  describe ".median" do
-    it "calculates the median of an array with an odd number of elements" do
-      [2, 3, 5, 1, 4].median.should eql(3)
-    end
+      it "calculates the mode of an unimodal array" do
+        [1, 1, 1, 2, 3, 4, 5, 5, 6].mode.should eql([1])
+      end
 
-    it "calculates the median of an array with an even number of elements" do
-      [2, 3, 5, 1, 4, 6].median.should eql(3.5)
+      it "calculates the mode of a bimodal array" do
+        [44, 45, 46, 44, 46, 50].mode.should eql([44, 46])
+      end
     end
   end
 
-  describe ".mode" do
-    it "calculates the mode of an empty array" do
-      [].mode.should eql([])
+  context "Dispersion" do
+    describe ".range" do
+      it "finds the range of an array" do
+        [0, 34, 656, 400, 1000].range.should be(1000)
+      end
     end
 
-    it "calculates the mode of an array with one element" do
-      [100].mode.should eql([100])
+    describe ".standard_deviation" do
+      it "calculates the standard deviation of an array" do
+        [1, 2, 3, 4, 5, 6].standard_deviation.should be_within(0.00001).of(1.70783)
+      end
     end
 
-    it "calculates the mode of an unimodal array" do
-      [1, 1, 1, 2, 3, 4, 5, 5, 6].mode.should eql([1])
+    describe ".coefficient_of_variation" do
+      it "calculates the coefficient of variation of an array" do
+        [1, 2, 3, 4, 5, 6].coefficient_of_variation.should be_within(0.00001).of(0.48795)
+      end
     end
 
-    it "calculates the mode of a bimodal array" do
-      [44, 45, 46, 44, 46, 50].mode.should eql([44, 46])
+    describe ".percentile" do
+      it "finds the 30th percentile of an array" do
+        [1, 2, 3, 4, 5, 6, 7, 8, 9, 10].percentile(30).should be(3)
+      end
+
+      it "finds the 50th percentile of an array" do
+        [1, 2, 3, 4, 5].percentile(50).should be(3)
+      end
+
+      it "finds the 10th percentile of an array" do
+        [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17].percentile(10).should be(2)
+      end
     end
-  end
 
-  describe ".standard_deviation" do
-    it "calculates the variance of an array" do
-      [1, 2, 3, 4, 5, 6].variance.should be_within(0.00001).of(2.91667)
+    describe ".interquartile_range" do
+      it "finds the interquartile range of an array" do
+        [1, 2, 3, 4, 5, 6, 7, 8, 9, 10].interquartile_range.should be(5)
+      end
     end
+  end
+
+  context "Shape" do
+    describe ".central_moment" do
+      it "calculates the 0th central moment of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].central_moment(0).should be_within(0.00001).of(1.0)
+      end
+
+      it "calculates the 1st central moment of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].central_moment(1).should be_within(0.00001).of(0.0)
+      end
 
-    it "calculates the standard deviation of an array" do
-      [1, 2, 3, 4, 5, 6].standard_deviation.should be_within(0.00001).of(1.70783)
+      it "calculates the 2nd central moment of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].central_moment(2).should be_within(0.00001).of(3459.44000)
+      end
+
+      it "calculates the 3rd central moment of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].central_moment(3).should be_within(0.00001).of(321046.00800)
+      end
+
+      it "calculates the 4th central moment of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].central_moment(4).should be_within(0.00001).of(56245095.69920)
+      end
     end
 
-    it "calculates the coefficient of variation of an array" do
-      [1, 2, 3, 4, 5, 6].coefficient_of_variation.should be_within(0.00001).of(0.48795)
+    describe ".raw_moment" do
+      it "calculates the 0th central moment of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].raw_moment(0).should be_within(0.00001).of(1.0)
+      end
+
+      it "calculates the 1st central moment of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].raw_moment(1).should be_within(0.00001).of([2, 43, 5, 65, 56, 7, 85, 3, -1, 199].mean)
+      end
+
+      it "calculates the 2nd central moment of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].raw_moment(2).should be_within(0.00001).of(5612.40000)
+      end
+
+      it "calculates the 3rd central moment of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].raw_moment(3).should be_within(0.00001).of(902497.40000)
+      end
+
+      it "calculates the 4th central moment of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].raw_moment(4).should be_within(0.00001).of(165154687.20000)
+      end
     end
-  end
 
-  describe ".percentile" do
-    it "finds the 30th percentile of an array" do
-      [1, 2, 3, 4, 5, 6, 7, 8, 9, 10].percentile(30).should be(3)
+    describe ".variance" do
+      it "calculates the variance of an array" do
+        [1, 2, 3, 4, 5, 6].variance.should be_within(0.00001).of(2.91667)
+      end
     end
 
-    it "finds the 50th percentile of an array" do
-      [1, 2, 3, 4, 5].percentile(50).should be(3)
+    describe ".skewness" do
+      it "finds the skewness of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].skewness.should be_within(0.00001).of(1.57782)
+      end
     end
 
-    it "finds the 10th percentile of an array" do
-      [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17].percentile(10).should be(2)
+    describe ".kurtosis" do
+      it "finds the kurtosis of an array" do
+        [2, 43, 5, 65, 56, 7, 85, 3, -1, 199].kurtosis.should be_within(0.00001).of(1.69973)
+      end
     end
+  end
 
-    it "finds the interquartile range of an array" do
-      [1, 2, 3, 4, 5, 6, 7, 8, 9, 10].interquartile_range.should be(5)
+  context "Count Data" do
+    describe ".index_of_dispersion" do
+      it "finds the index of dispersion of an array" do
+        [1, 2, 3, 4, 5, 6].index_of_dispersion.should be_within(0.00001).of(0.83333)
+      end
     end
   end
 end

data/spec/rstat/fixnum_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Rstat do
+  describe ".binomial_coefficient" do
+    it "computes the binomial coeffecient of itself and another number" do
+      10.binomial_coefficient(4).should eq(210)
+
+      50.binomial_coefficient(34).should eq(4_923_689_695_575)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rstat
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-07 00:00:00.000000000 Z
+date: 2012-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -43,17 +43,29 @@ files:
 - lib/rstat.rb
 - lib/rstat/core_ext.rb
 - lib/rstat/core_ext/array.rb
-- lib/rstat/core_ext/array/mean.rb
-- lib/rstat/core_ext/array/median.rb
-- lib/rstat/core_ext/array/mode.rb
-- lib/rstat/core_ext/array/percentile.rb
+- lib/rstat/core_ext/array/descriptive_statistics.rb
+- lib/rstat/core_ext/array/descriptive_statistics/dispersion.rb
+- lib/rstat/core_ext/array/descriptive_statistics/dispersion/percentile.rb
+- lib/rstat/core_ext/array/descriptive_statistics/dispersion/range.rb
+- lib/rstat/core_ext/array/descriptive_statistics/dispersion/standard_deviation.rb
+- lib/rstat/core_ext/array/descriptive_statistics/index_of_dispersion.rb
+- lib/rstat/core_ext/array/descriptive_statistics/location.rb
+- lib/rstat/core_ext/array/descriptive_statistics/location/mean.rb
+- lib/rstat/core_ext/array/descriptive_statistics/location/median.rb
+- lib/rstat/core_ext/array/descriptive_statistics/location/mode.rb
+- lib/rstat/core_ext/array/descriptive_statistics/shape.rb
+- lib/rstat/core_ext/array/descriptive_statistics/shape/kurtosis.rb
+- lib/rstat/core_ext/array/descriptive_statistics/shape/moment.rb
+- lib/rstat/core_ext/array/descriptive_statistics/shape/skewness.rb
+- lib/rstat/core_ext/array/descriptive_statistics/shape/variance.rb
 - lib/rstat/core_ext/array/product.rb
-- lib/rstat/core_ext/array/range.rb
-- lib/rstat/core_ext/array/standard_deviation.rb
 - lib/rstat/core_ext/array/sum.rb
+- lib/rstat/core_ext/fixnum.rb
+- lib/rstat/core_ext/fixnum/binomial_coefficient.rb
 - lib/rstat/version.rb
 - rstat.gemspec
 - spec/rstat/array_spec.rb
+- spec/rstat/fixnum_spec.rb
 - spec/spec_helper.rb
 homepage: http://seaneshbaugh.com/
 licenses: []
@@ -81,4 +93,5 @@ specification_version: 3
 summary: A Simple statistics gem.
 test_files:
 - spec/rstat/array_spec.rb
+- spec/rstat/fixnum_spec.rb
 - spec/spec_helper.rb