ruby-nuggets 0.7.0 → 0.7.1

data/.rspec

@@ -1,2 +1,3 @@
 --colour
 --debug
+--require spec/spec_helper

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to ruby-nuggets version 0.7.0
+This documentation refers to ruby-nuggets version 0.7.1
 
 
 == DESCRIPTION

data/lib/nuggets/array/correlation_mixin.rb

@@ -25,14 +25,14 @@
 ###############################################################################
 #++
 
-require 'nuggets/array/variance_mixin'
+require 'nuggets/array/standard_deviation_mixin'
 
 module Nuggets
   class Array
     module CorrelationMixin
 
   def self.included(base)
-    base.send :include, Nuggets::Array::VarianceMixin
+    base.send :include, Nuggets::Array::StandardDeviationMixin
   end
 
   # call-seq:
@@ -40,18 +40,21 @@ module Nuggets
   #
   # Calculates the {Pearson product-moment correlation
   # coefficient}[http://en.wikipedia.org/wiki/Pearson_product-moment_correlation_coefficient]
-  # for the <tt>{x,y}</tt> pairs in _array_.
+  # for the <tt>{x,y}</tt> pairs in _array_. If _array_ only contains
+  # values instead of pairs, +y+ will be the value and +x+ will be each
+  # value's position (rank) in _array_.
   def correlation_coefficient
-    sx, sy = 0.0, 0.0
+    return 0.0 if empty?
 
-    return sx if empty?
+    target = first.respond_to?(:to_ary) ? self :
+      ::Array.new(size) { |i| i + 1 }.zip(self)
 
-    each { |x, y|
-      sx += x
-      sy += y
-    }
+    sx = target.std { |x, _| x }
+    sy = target.std { |_, y| y }
 
-    (sx * cov) / (sy * var { |x, _| x })
+    c = target.cov
+
+    sx.zero? || sy.zero? ? c < 0 ? -1.0 : 1.0 : c / (sx * sy)
   end
 
   alias_method :corr, :correlation_coefficient

data/lib/nuggets/array/histogram_mixin.rb

@@ -72,6 +72,21 @@ module Nuggets
     hist
   end
 
+  # call-seq:
+  #   array.probability_mass_function => aHash
+  #   array.probability_mass_function { |x| ... } => aHash
+  #
+  # Calculates the {probability mass function}[http://en.wikipedia.org/wiki/Probability_mass_function]
+  # (normalized histogram) of the values in _array_. Returns a Hash that
+  # maps any value, or the result of the value yielded to the block, to
+  # its probability (via #histogram).
+  def probability_mass_function(&block)
+    hist, n = histogram(&block), size.to_f
+    hist.each { |k, v| hist[k] = v / n }
+  end
+
+  alias_method :pmf, :probability_mass_function
+
   # call-seq:
   #   array.annotated_histogram => anArray
   #   array.annotated_histogram { |hist_item| ... } => aHash

data/lib/nuggets/array/regression_mixin.rb

@@ -25,35 +25,42 @@
 ###############################################################################
 #++
 
-require 'nuggets/array/correlation_mixin'
+require 'nuggets/array/variance_mixin'
 
 module Nuggets
   class Array
     module RegressionMixin
 
   def self.included(base)
-    base.send :include, Nuggets::Array::CorrelationMixin
+    base.send :include, Nuggets::Array::VarianceMixin
   end
 
   # call-seq:
   #   array.linear_least_squares => anArray
   #
-  # Calculates the {linear least squares regression}[http://en.wikipedia.org/wiki/Ordinary_least_squares]
-  # for the <tt>{x,y}</tt> pairs in _array_.
+  # Calculates the {linear least squares regression}[http://en.wikipedia.org/wiki/Simple_linear_regression]
+  # for the <tt>{x,y}</tt> pairs in _array_. If _array_ only contains
+  # values instead of pairs, +y+ will be the value and +x+ will be each
+  # value's position (rank) in _array_.
   def linear_least_squares
-    sx, sy = 0.0, 0.0
-
     return [] if empty?
 
-    each { |x, y|
+    target = first.respond_to?(:to_ary) ? self :
+      ::Array.new(size) { |i| i + 1 }.zip(self)
+
+    sx, sy = 0.0, 0.0
+
+    target.each { |x, y|
       sx += x
       sy += y
     }
 
-    b = corr * sy / sx
-    a = (sy - b * sx) / size.to_f
+    v = target.var { |x, _| x }
+
+    b = v.zero? ? 0.0 : target.cov / v
+    a = (sy - b * sx) / size
 
-    map { |x, _| [x, a + b * x] }
+    target.map { |x, _| [x, a + b * x] }
   end
 
   alias_method :llsq, :linear_least_squares

data/lib/nuggets/array/variance_mixin.rb

@@ -54,14 +54,19 @@ module Nuggets
   # call-seq:
   #   array.covariance => aFloat
   #
-  # Calculates the covariance[http://en.wikipedia.org/wiki/Covariance] of the
-  # <tt>{x,y}</tt> pairs in _array_.
+  # Calculates the covariance[http://en.wikipedia.org/wiki/Covariance] of
+  # the <tt>{x,y}</tt> pairs in _array_. If _array_ only contains values
+  # instead of pairs, +y+ will be the value and +x+ will be each value's
+  # position (rank) in _array_.
   def covariance
     sx, sy, sp = 0.0, 0.0, 0.0
 
     return sx if empty?
 
-    each { |x, y|
+    target = first.respond_to?(:to_ary) ? self :
+      ::Array.new(size) { |i| i + 1 }.zip(self)
+
+    target.each { |x, y|
       sx += x
       sy += y
       sp += x * y

data/lib/nuggets/version.rb

@@ -4,7 +4,7 @@ module Nuggets
 
     MAJOR = 0
     MINOR = 7
-    TINY  = 0
+    TINY  = 1
 
     class << self
 

data/spec/nuggets/array/correlation_spec.rb

@@ -0,0 +1,83 @@
+require 'nuggets/array/correlation'
+
+describe Array, 'when extended by', Nuggets::Array::CorrelationMixin do
+
+  it { Array.ancestors.should include(Nuggets::Array::CorrelationMixin) }
+
+  example do
+    [].correlation_coefficient.should == 0.0
+  end
+
+  example do
+    [1].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [1, 1, 1].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [1, 2, 3].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [-1, -2, -3].correlation_coefficient.should == -1.0
+  end
+
+  example do
+    [1, 1.5, 2].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [3, 2, 1].correlation_coefficient.should == -1.0
+  end
+
+  example do
+    [-3, -2, -1].correlation_coefficient.should == -[3, 2, 1].correlation_coefficient
+  end
+
+  example do
+    [1, -2, 1, 2, 3, -4, 0, 3, 1, 2, 1, 0, 24].correlation_coefficient.should equal_float(0.478471417102228)
+  end
+
+  example do
+    [[1, 1]].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [[1, 1], [1, 1], [1, 1]].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [[-1, 1], [-1, 1], [-1, 1]].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [[1, -1], [1, -1], [1, -1]].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [[1, 1], [1, 2], [1, 3]].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [[1, 1], [2, 1], [3, 1]].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [[-1, 1], [-2, 1], [-3, 1]].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [[1, -1], [2, -1], [3, -1]].correlation_coefficient.should == 1.0
+  end
+
+  example do
+    [[3, 1], [2, 2], [1, 3]].correlation_coefficient.should == -1.0
+  end
+
+  example do
+    [[-3, 3], [-2, 2], [-1, 1]].correlation_coefficient.should == -[[3, 3], [2, 2], [1, 1]].correlation_coefficient
+  end
+
+end

data/spec/nuggets/array/histogram_spec.rb

@@ -0,0 +1,89 @@
+require 'nuggets/array/histogram'
+
+describe Array, 'when extended by', Nuggets::Array::HistogramMixin do
+
+  it { Array.ancestors.should include(Nuggets::Array::HistogramMixin) }
+
+  example do
+    [].histogram.should == {}
+  end
+
+  example do
+    [1].histogram.should == { 1 => 1 }
+  end
+
+  example do
+    [1, 1, 1].histogram.should == { 1 => 3 }
+  end
+
+  example do
+    [1, 2, 2, 3].histogram.should == { 1 => 1, 2 => 2, 3 => 1 }
+  end
+
+  example do
+    [3, 2, 2, 1].histogram.should == [1, 2, 2, 3].histogram
+  end
+
+  example do
+    [1, -2, 1, 2, 3, -4, 0, 3, 1, 2, 1, 0, 24].histogram.should == {
+      -4 => 1, -2 => 1, 0 => 2, 1 => 4, 2 => 2, 3 => 2, 24 => 1
+    }
+  end
+
+  example do
+    %w[one two three three].histogram.should == { 'one' => 1, 'two' => 1, 'three' => 2 }
+  end
+
+  example do
+    %w[three two one three].histogram.should == %w[one two three three].histogram
+  end
+
+  example do
+    [1, 2, 2, 3, 4].histogram { |x| x * 2 }.should == { 2 => 1, 4 => 2, 6 => 1, 8 => 1 }
+  end
+
+  example do
+    [1, 2, 3, 4].histogram { |x| x / 2 }.should == { 0 => 1, 1 => 2, 2 => 1 }
+  end
+
+  example do
+    [].probability_mass_function.should == {}
+  end
+
+  example do
+    [1].probability_mass_function.should == { 1 => 1 }
+  end
+
+  example do
+    [1, 1, 1].probability_mass_function.should == { 1 => 1 }
+  end
+
+  example do
+    [1, 2, 2, 3].probability_mass_function.should == { 1 => 0.25, 2 => 0.5, 3 => 0.25 }
+  end
+
+  example do
+    [3, 2, 2, 1].probability_mass_function.should == [1, 2, 2, 3].probability_mass_function
+  end
+
+  example do
+    [1, -2, 1, 2, 3, -4, 0, 3, 1, 2, 1, 0, 24].probability_mass_function.values.inject(:+).should == 1.0
+  end
+
+  example do
+    %w[one two three three].probability_mass_function.should == { 'one' => 0.25, 'two' => 0.25, 'three' => 0.5 }
+  end
+
+  example do
+    %w[three two one three].probability_mass_function.should == %w[one two three three].probability_mass_function
+  end
+
+  example do
+    [1, 2, 2, 3, 4].probability_mass_function { |x| x * 2 }.should == { 2 => 0.2, 4 => 0.4, 6 => 0.2, 8 => 0.2 }
+  end
+
+  example do
+    [1, 2, 3, 4].probability_mass_function { |x| x / 2 }.should == { 0 => 0.25, 1 => 0.5, 2 => 0.25 }
+  end
+
+end

data/spec/nuggets/array/mean_spec.rb

@@ -120,8 +120,4 @@ describe Array, 'when extended by', Nuggets::Array::MeanMixin do
   # TODO: other methods
   # TODO: more examples: http://people.revoledu.com/kardi/tutorial/BasicMath/Average/mean.html
 
-  def equal_float(value, precision = 1.0e-14)
-    be_within(precision).of(value)
-  end
-
 end

data/spec/nuggets/array/regression_spec.rb

@@ -0,0 +1,40 @@
+require 'nuggets/array/regression'
+
+describe Array, 'when extended by', Nuggets::Array::RegressionMixin do
+
+  it { Array.ancestors.should include(Nuggets::Array::RegressionMixin) }
+
+  example {
+    [].linear_least_squares.should == []
+  }
+
+  example {
+    [0].linear_least_squares.should == [[1, 0]]
+  }
+
+  example {
+    [1].linear_least_squares.should == [[1, 1]]
+  }
+
+  example {
+    [1, 1].linear_least_squares.should == [[1, 1], [2, 1]]
+  }
+
+  example {
+    [1, 2, 3, 4].linear_least_squares.should == [[1, 1], [2, 2], [3, 3], [4, 4]]
+  }
+
+  example {
+    [1, 2, 4, 1].linear_least_squares.should == [[1, 1.7], [2, 1.9], [3, 2.1], [4, 2.3]]
+  }
+
+  example {
+    r = [2.3, 1.6, 0.9, 0.2]
+
+    [1, 2, 4, -2].linear_least_squares.each_with_index { |(x, y), i|
+      x.should == i + 1
+      y.should equal_float(r[i])
+    }
+  }
+
+end

data/spec/nuggets/array/standard_deviation_spec.rb

@@ -17,11 +17,11 @@ describe Array, 'when extended by', Nuggets::Array::StandardDeviationMixin do
   end
 
   example do
-    [1, 2, 3].standard_deviation.should be_within(0.0001).of(0.8165)
+    [1, 2, 3].standard_deviation.should equal_float(0.816496580927726)
   end
 
   example do
-    [3, 2, 1].standard_deviation.should be_within(0.0001).of(0.8165)
+    [3, 2, 1].standard_deviation.should equal_float(0.816496580927726)
   end
 
   example do
@@ -29,7 +29,7 @@ describe Array, 'when extended by', Nuggets::Array::StandardDeviationMixin do
   end
 
   example do
-    [1, -2, 1, 2, 3, -4, 0, 3, 1, 2, 1, 0, 24].standard_deviation.should be_within(0.01).of(6.49)
+    [1, -2, 1, 2, 3, -4, 0, 3, 1, 2, 1, 0, 24].standard_deviation.should equal_float(6.48804088737217)
   end
 
 end

data/spec/nuggets/array/variance_spec.rb

@@ -29,7 +29,64 @@ describe Array, 'when extended by', Nuggets::Array::VarianceMixin do
   end
 
   example do
-    [1, -2, 1, 2, 3, -4, 0, 3, 1, 2, 1, 0, 24].variance.should be_within(0.1).of(42.0)
+    [1, -2, 1, 2, 3, -4, 0, 3, 1, 2, 1, 0, 24].variance.should equal_float(42.0946745562130218)
+  end
+
+  example do
+    [].covariance.should == 0.0
+  end
+
+  example do
+    [1].covariance.should == 0.0
+  end
+
+  example do
+    [1, 1, 1].covariance.should == 0.0
+  end
+
+  example do
+    [1, 2, 3].covariance.should == 2 / 3.0
+  end
+
+  example do
+    [3, 2, 1].covariance.should == -2 / 3.0
+  end
+
+  example do
+    [-3, -2, -1].covariance.should == -[3, 2, 1].covariance
+  end
+
+  example do
+    [1, -2, 1, 2, 3, -4, 0, 3, 1, 2, 1, 0, 24].covariance.should equal_float(11.615384615384615)
+  end
+
+  example do
+    a = [1, -2, 1, 2, 3, -4, 0, 3, 1, 2, 1, 0, 24]
+    a.zip(Array.new(a.size) { 42 }).covariance.should == 0.0
+  end
+
+  example do
+    a = [1, -2, 1, 2, 3, -4, 0, 3, 1, 2, 1, 0, 24]
+    a.zip(a).covariance.should == a.variance
+  end
+
+  example do
+    a, b = [1, -2, 1, 2, 3, -4], [3, 1, 2, 1, 0, 24]
+    a.zip(b).covariance.should == b.zip(a).covariance
+  end
+
+  example do
+    a, b = [1, -2, 1, 2, 3, -4], [3, 1, 2, 1, 0, 24]
+    m, n = 23, 42
+
+    a.map { |i| m * i }.zip(b.map { |i| n * i }).covariance.should == m * n * a.zip(b).covariance
+  end
+
+  example do
+    a, b = [1, -2, 1, 2, 3, -4], [3, 1, 2, 1, 0, 24]
+    m, n = 23, 42
+
+    a.map { |i| i + m }.zip(b.map { |i| i + n }).covariance.should equal_float(a.zip(b).covariance, 1.0e-13)
   end
 
 end

data/spec/nuggets/file/replace_spec.rb

@@ -94,11 +94,4 @@ BEFORE HE REACHED THE TOWN O
     end
   end
 
-  def tempfile
-    t = Tempfile.open('nuggets_file_replace_spec_temp') { |f| f.puts @txt }
-    block_given? ? yield(t.path) : t.path
-  ensure
-    t.close(true) if t
-  end
-
 end

data/spec/nuggets/file/sub_spec.rb

@@ -148,11 +148,4 @@ Before he reached the town o
     lambda { File.gsub!(tempfile, /ight/, 'XIGHTX') }.should raise_error(Errno::ENOENT)
   end
 
-  def tempfile
-    t = Tempfile.open('nuggets_file_sub_spec_temp') { |f| f.puts @txt }
-    block_given? ? yield(t.path) : t.path
-  ensure
-    t.close(true) if t
-  end
-
 end

data/spec/spec_helper.rb

@@ -1,14 +1,16 @@
-$:.unshift('lib') unless $:[0] == 'lib'
+$:.unshift('lib') unless $:.first == 'lib'
 
-#class << Spec::Matchers
-#
-#  def generated_description
-#    return nil if last_should.nil?
-#
-#    operator = last_should.to_s.tr('_', ' ')
-#    target = last_matcher.instance_variable_get(:@actual)
-#
-#    "#{target.inspect} #{operator} #{last_description}"
-#  end
-#
-#end
+RSpec.configure { |config|
+  config.include(Module.new {
+    def equal_float(value, precision = 1.0e-14)
+      be_within(precision).of(value)
+    end
+
+    def tempfile(txt = @txt)
+      t = Tempfile.open("nuggets_spec_#{object_id}_temp") { |f| f.puts txt }
+      block_given? ? yield(t.path) : t.path
+    ensure
+      t.close(true) if t
+    end
+  })
+}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-nuggets
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Jens Wille
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-05 00:00:00 Z
+date: 2011-04-06 00:00:00 Z
 dependencies: []
 
 description: Some extensions to the Ruby programming language.
@@ -155,7 +155,10 @@ files:
 - spec/nuggets/integer/length_spec.rb
 - spec/nuggets/array/mode_spec.rb
 - spec/nuggets/array/variance_spec.rb
+- spec/nuggets/array/correlation_spec.rb
 - spec/nuggets/array/runiq_spec.rb
+- spec/nuggets/array/histogram_spec.rb
+- spec/nuggets/array/regression_spec.rb
 - spec/nuggets/array/median_spec.rb
 - spec/nuggets/array/mean_spec.rb
 - spec/nuggets/array/limit_spec.rb
@@ -193,9 +196,9 @@ rdoc_options:
 - README
 - --charset
 - UTF-8
-- --all
 - --title
-- ruby-nuggets Application documentation (v0.7.0)
+- ruby-nuggets Application documentation (v0.7.1)
+- --all
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -219,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: prometheus
-rubygems_version: 1.7.1
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Some extensions to the Ruby programming language.