set_theory 0.0.4 → 0.0.5

data/README.md

@@ -17,14 +17,52 @@ _For the whole library_
 _Or choose the parts you want_
 
     require 'set_theory/member_of'
-    require 'set_theory/union'
-    require 'set_theory/intersection'
     require 'set_theory/difference'
+    require 'set_theory/intersection'
+    require 'set_theory/power_set'
     require 'set_theory/symmetric_difference'
+    require 'set_theory/union'
 
 Usage
 -----
 
+#### Membership (Object#member_of?)
+
+Returns true if the receiving object is found within an array.
+
+    1.member_of? [1, 2, 3]     #=> true
+
+#### Difference (Array#difference)
+
+Returns an array with the objects of the receiving array that are not in the passed array.
+
+    [1, 2, 3].difference [2, 3, 4]    #=> [1]
+    [2, 3, 4].difference [1, 2, 3]    #=> [4]
+
+#### Intersection (Array#intersection)
+
+Returns an array containing only the objects that are members of both the receiving and passed array.
+
+    [1, 2, 3].intersection [2, 3, 4]    #=> [2, 3]
+
+#### Power set (Array#power_set)
+
+Returns an array with all possible subsets of the receiving array.
+
+    [1, 2, 3].power_set    #=> [[], [1], [2], [1, 2], [3], [1, 3], [2, 3], [1, 2, 3]]
+
+#### Symmetric difference (Array#symmetric_difference)
+
+Returns an array containing only the objects that are in one of the receiving or passed arrays, but not both.
+
+    [1, 2, 3].symmetric_difference [2, 3, 4]    #=> [1, 4]
+
+#### Union (Array#union)
+
+Returns an array containing all members the receiving and passed arrays.
+
+    [1, 2, 3].union [2, 3, 4]    #=> [1, 2, 3, 4]
+
 Development and Testing
 -----------------------
 
@@ -41,19 +79,23 @@ _Install dependencies_
 
 _Then run the specs_
 
-    rake
+    bundle exec rake
 
 TODO
 ----
 
 * Possibly deal with type errors on parameter to member_of?
-* Add aliases for other set operations.
-* Add methods for missing set operations.
 
 Rationale
 ---------
 Yes, I know about [this patch](https://github.com/rails/rails/pull/265), but I prefer `Object#member_of?` and `!Object#member_of?`.
 
+References
+----------
+[http://en.wikipedia.org/wiki/Set_theory](http://en.wikipedia.org/wiki/Set_theory)
+
+[http://rosettacode.org/wiki/Power_Set#Ruby](http://rosettacode.org/wiki/Power_Set#Ruby)
+
 Copyright
 ---------
 See LICENSE for details.

data/benchmark/power_set.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+# There are two methods described here for calculating the power set of
+# a set.
+#
+# First is using a nice Ruby implementation from
+# http://rosettacode.org/wiki/Power_Set#Ruby
+#
+# Second is using a binary count method.
+#
+
+require 'pp'
+require 'benchmark'
+
+array = [1,2,3,4,5,6,7,8,9,0,10,11,12,13,14,15,16,17,18,19]
+
+puts "set size: #{array.size}"
+
+inject = Benchmark.measure do
+
+  array.inject([[]]) { |ps,item|
+     ps + ps.map { |e| e + [item] }
+  }
+
+end
+puts "inject: #{inject}"
+
+binary = Benchmark.measure do
+
+  out = []
+  (2**array.size).times do |i|
+    a = []
+    binary = i.to_s(2).rjust(array.size, '0')
+    binary.size.times do |j|
+      a << array[j] if binary[j] == '1'
+    end
+    out << a
+  end
+
+end
+puts "binary: #{binary}"

data/lib/set_theory/power_set.rb

@@ -0,0 +1,8 @@
+class Array
+  # Taken from http://rosettacode.org/wiki/Power_Set#Ruby
+  def power_set
+    self.inject([[]]) { |set,item|
+      set + set.map { |e| e + [item] }
+    }
+  end
+end

data/lib/set_theory/version.rb

@@ -1,3 +1,3 @@
 module SetTheory
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/set_theory.rb

@@ -3,3 +3,4 @@ require "set_theory/union"
 require "set_theory/intersection"
 require "set_theory/difference"
 require "set_theory/symmetric_difference"
+require "set_theory/power_set"

data/set_theory.gemspec

@@ -9,11 +9,12 @@ Gem::Specification.new do |s|
   s.authors     = ["Tim Preston"]
   s.email       = ["tim@tp.id.au"]
   s.homepage    = "http://github.com/tehpeh/set_theory"
-  s.summary     = %q{Extends Object with nice names for set operations.}
-  s.description = %q{Extends Object with nice names for set operations.}
+  s.summary     = %q{Extends Object and Array with nice names for set operations.}
+  s.description = %q{Extends Object and Array with nice names for set operations.\nSee the Set class (http://www.ruby-doc.org/stdlib/libdoc/set/rdoc/index.html) for a library that doesn't pollute your Objects and Arrays.}
 
   s.rubyforge_project = "set_theory"
 
+  s.add_development_dependency "rake", "0.8.7"
   s.add_development_dependency "gem-release", "~> 0.0.16"
   s.add_development_dependency "rspec", "~> 2.6.0"
   s.add_development_dependency "guard", "~> 0.3.4"

data/spec/set_theory/power_set_spec.rb

@@ -0,0 +1,14 @@
+require 'set_theory/power_set'
+
+describe Array do
+  it 'responds to #power_set' do
+    Array.new.respond_to?(:power_set).should be
+  end
+
+  describe '#power_set' do
+    it 'calculates the power set of the set' do
+      ([1, 2, 3].power_set).should
+        eql [[], [1], [2], [3], [1, 2], [1, 3], [2, 3], [1, 2, 3]].sort
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: set_theory
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Tim Preston
@@ -10,65 +10,76 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-25 00:00:00 +10:00
+date: 2011-05-30 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: gem-release
+  name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: gem-release
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 0.0.16
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 2.6.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: guard
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 0.3.4
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: guard-rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 0.3.1
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rb-fsevent
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 0.4.0
   type: :development
-  version_requirements: *id005
-description: Extends Object with nice names for set operations.
+  version_requirements: *id006
+description: Extends Object and Array with nice names for set operations.\nSee the Set class (http://www.ruby-doc.org/stdlib/libdoc/set/rdoc/index.html) for a library that doesn't pollute your Objects and Arrays.
 email: 
 - tim@tp.id.au
 executables: []
@@ -86,10 +97,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- benchmark/power_set.rb
 - lib/set_theory.rb
 - lib/set_theory/difference.rb
 - lib/set_theory/intersection.rb
 - lib/set_theory/member_of.rb
+- lib/set_theory/power_set.rb
 - lib/set_theory/symmetric_difference.rb
 - lib/set_theory/union.rb
 - lib/set_theory/version.rb
@@ -97,6 +110,7 @@ files:
 - spec/set_theory/difference_spec.rb
 - spec/set_theory/intersection_spec.rb
 - spec/set_theory/member_of_spec.rb
+- spec/set_theory/power_set_spec.rb
 - spec/set_theory/symmetric_difference_spec.rb
 - spec/set_theory/union_spec.rb
 has_rdoc: true
@@ -126,10 +140,11 @@ rubyforge_project: set_theory
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Extends Object with nice names for set operations.
+summary: Extends Object and Array with nice names for set operations.
 test_files: 
 - spec/set_theory/difference_spec.rb
 - spec/set_theory/intersection_spec.rb
 - spec/set_theory/member_of_spec.rb
+- spec/set_theory/power_set_spec.rb
 - spec/set_theory/symmetric_difference_spec.rb
 - spec/set_theory/union_spec.rb