combinatorics 0.1.0

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,8 @@
+pkg
+doc
+web
+tmp
+.DS_Store
+.yardoc
+*.swp
+*~

data/.specopts

@@ -0,0 +1 @@
+--colour --format specdoc

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'Combinatorics Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,6 @@
+### 0.1.0 / 2010-10-02
+
+* Initial release:
+  * Adds `powerset` to {Array} and {Set}.
+  * Adds Haskell/Python style list comprehensions via {Array#comprehension}.
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+Copyright (c) 2010 Hal Brodigan
+
+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/README.md

@@ -0,0 +1,84 @@
+# Combinatorics
+
+* [github.com/postmodern/combinatorics](http://github.com/postmodern/combinatorics)
+* [github.com/postmodern/combinatorics/issues](http://github.com/postmodern/combinatorics/issues)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+A collection of modules and methods for performing
+[Combinatoric](http://en.wikipedia.org/wiki/Combinatoric) calculations.
+
+## Features
+
+* Adds `powerset` to {Array} and {Set}.
+* Adds Haskell/Python style list comprehensions via {Array#comprehension}.
+
+## Examples
+
+Power-set of an {Array}:
+
+    require 'combinatorics/power_set'
+
+    [1,2,3,4].powerset
+    # => [[],
+          [4],
+          [3],
+          [3, 4],
+          [2],
+          [2, 4],
+          [2, 3],
+          [2, 3, 4],
+          [1],
+          [1, 4],
+          [1, 3],
+          [1, 3, 4],
+          [1, 2],
+          [1, 2, 4],
+          [1, 2, 3],
+          [1, 2, 3, 4]]
+
+Power-set of a {Set}:
+
+    Set['ab', 'cd', 'ef'].powerset
+    # => [#<Set: {}>,
+          #<Set: {"ef"}>,
+          #<Set: {"cd"}>,
+          #<Set: {"cd", "ef"}>,
+          #<Set: {"ab"}>,
+          #<Set: {"ab", "ef"}>,
+          #<Set: {"ab", "cd"}>,
+          #<Set: {"ab", "cd", "ef"}>]
+
+List comprehensions:
+
+    require 'combinatorics/list_comprehension'
+
+    [(0..10).step(2),('a'..'c')].comprehension.to_a
+    # => [[0, "a"],
+          [0, "b"],
+          [0, "c"],
+          [2, "a"],
+          [2, "b"],
+          [2, "c"],
+          [4, "a"],
+          [4, "b"],
+          [4, "c"],
+          [6, "a"],
+          [6, "b"],
+          [6, "c"],
+          [8, "a"],
+          [8, "b"],
+          [8, "c"],
+          [10, "a"],
+          [10, "b"],
+          [10, "c"]]
+
+## Install
+
+    $ sudo gem install combinatorics
+
+## License
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'jeweler', '~> 1.4.0'
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'combinatorics'
+    gem.summary = %Q{Bringing (more) Combinatorics to Ruby}
+    gem.description = %Q{A collection of modules and methods for performing Combinatoric calculations.}
+    gem.email = 'postmodern.mod3@gmail.com'
+    gem.homepage = 'http://github.com/postmodern/combinatorics'
+    gem.authors = ['Postmodern']
+    gem.add_development_dependency 'rspec', '~> 1.3.0'
+    gem.add_development_dependency 'yard', '~> 0.6.0'
+    gem.add_development_dependency 'jeweler', '~> 1.4.0'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs += %w[lib spec]
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = %w[--options .specopts]
+end
+
+task :spec => :check_dependencies
+task :default => :spec
+
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/combinatorics.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{combinatorics}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Postmodern"]
+  s.date = %q{2010-10-02}
+  s.description = %q{A collection of modules and methods for performing Combinatoric calculations.}
+  s.email = %q{postmodern.mod3@gmail.com}
+  s.extra_rdoc_files = [
+    "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".specopts",
+     ".yardopts",
+     "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "combinatorics.gemspec",
+     "lib/combinatorics.rb",
+     "lib/combinatorics/list_comprehension.rb",
+     "lib/combinatorics/power_set.rb",
+     "lib/combinatorics/power_set/extensions.rb",
+     "lib/combinatorics/power_set/extensions/array.rb",
+     "lib/combinatorics/power_set/extensions/set.rb",
+     "lib/combinatorics/power_set/mixin.rb",
+     "spec/.rspec",
+     "spec/combinatorics_spec.rb",
+     "spec/list_comprehension_spec.rb",
+     "spec/power_set/array_spec.rb",
+     "spec/power_set/mixin_examples.rb",
+     "spec/power_set/set_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/postmodern/combinatorics}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Bringing (more) Combinatorics to Ruby}
+  s.test_files = [
+    "spec/combinatorics_spec.rb",
+     "spec/list_comprehension_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/power_set/set_spec.rb",
+     "spec/power_set/array_spec.rb",
+     "spec/power_set/mixin_examples.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.4.0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+  end
+end
+

data/lib/combinatorics.rb

@@ -0,0 +1,2 @@
+require 'combinatorics/list_comprehension'
+require 'combinatorics/power_set'

data/lib/combinatorics/list_comprehension.rb

@@ -0,0 +1,74 @@
+class Array
+
+  #
+  # Iterates over each permutation of the enumerable values within the
+  # {Array}.
+  #
+  # @yield [list]
+  #   The given block will be passed each permutation of the enumerable
+  #   values in the {Array}.
+  #
+  # @yieldparam [Array] list
+  #   A permutation of the enumerable values within the {Array}.
+  #
+  # @return [Enumerator]
+  #   If no block is given, an enumerator object will be returned.
+  #
+  # @example
+  #   [(1..5),(1..4),(1..3)].comprehension.to_a
+  #   # => [
+  #     [1, 1, 1], [1, 1, 2], [1, 1, 3],
+  #     [1, 2, 1], [1, 2, 2], [1, 2, 3],
+  #     [1, 3, 1], [1, 3, 2], [1, 3, 3],
+  #     [1, 4, 1], [1, 4, 2], [1, 4, 3],
+  #     [2, 1, 1], [2, 1, 2], [2, 1, 3],
+  #     [2, 2, 1], [2, 2, 2], [2, 2, 3],
+  #     [2, 3, 1], [2, 3, 2], [2, 3, 3],
+  #     [2, 4, 1], [2, 4, 2], [2, 4, 3],
+  #     [3, 1, 1], [3, 1, 2], [3, 1, 3],
+  #     [3, 2, 1], [3, 2, 2], [3, 2, 3],
+  #     [3, 3, 1], [3, 3, 2], [3, 3, 3],
+  #     [3, 4, 1], [3, 4, 2], [3, 4, 3],
+  #     [4, 1, 1], [4, 1, 2], [4, 1, 3],
+  #     [4, 2, 1], [4, 2, 2], [4, 2, 3],
+  #     [4, 3, 1], [4, 3, 2], [4, 3, 3],
+  #     [4, 4, 1], [4, 4, 2], [4, 4, 3],
+  #     [5, 1, 1], [5, 1, 2], [5, 1, 3],
+  #     [5, 2, 1], [5, 2, 2], [5, 2, 3],
+  #     [5, 3, 1], [5, 3, 2], [5, 3, 3],
+  #     [5, 4, 1], [5, 4, 2], [5, 4, 3]
+  #   ]
+  #
+  def comprehension
+    return enum_for(:comprehension) unless block_given?
+
+    if empty?
+      yield self
+      return nil
+    end
+
+    enums = self.map do |value|
+      if value.kind_of?(Enumerable)
+        value
+      else
+        (value..value)
+      end
+    end
+
+    cycles = enums.map { |e| e.cycle }
+    start = cycles.map { |e| e.next }
+    iteration = start.dup
+
+    loop do
+      yield iteration.dup
+
+      (cycles.length - 1).downto(0) do |index|
+        iteration[index] = cycles[index].next
+        break unless iteration[index] == start[index]
+
+        return nil if index == 0
+      end
+    end
+  end
+
+end

data/lib/combinatorics/power_set.rb

@@ -0,0 +1,2 @@
+require 'combinatorics/power_set/mixin'
+require 'combinatorics/power_set/extensions'

data/lib/combinatorics/power_set/extensions.rb

@@ -0,0 +1,2 @@
+require 'combinatorics/power_set/extensions/array'
+require 'combinatorics/power_set/extensions/set'

data/lib/combinatorics/power_set/extensions/array.rb

@@ -0,0 +1,7 @@
+require 'combinatorics/power_set/mixin'
+
+class Array
+
+  include Combinatorics::PowerSet::Mixin
+
+end

data/lib/combinatorics/power_set/extensions/set.rb

@@ -0,0 +1,9 @@
+require 'combinatorics/power_set/mixin'
+
+require 'set'
+
+class Set
+
+  include Combinatorics::PowerSet::Mixin
+
+end

data/lib/combinatorics/power_set/mixin.rb

@@ -0,0 +1,40 @@
+module Combinatorics
+  module PowerSet
+    module Mixin
+      #
+      # Calculates the power-set of an Enumerable object.
+      #
+      # @return [Array]
+      #   The power set.
+      #
+      # @example Power-set of an Array.
+      #   [1,2,3].powerset
+      #   # => [[], [3], [2], [2, 3], [1], [1, 3], [1, 2], [1, 2, 3]]
+      #
+      # @example Power-set on a Set of strings.
+      #   Set['abc', 'xyz', '123'].powerset
+      #   # => [#<Set: {}>, #<Set: {"123"}>, #<Set: {"xyz"}>,
+      #         #<Set: {"abc"}>, #<Set: {"xyz", "123"}>,
+      #         #<Set: {"abc", "123"}>, #<Set: {"abc", "xyz"}>,
+      #         #<Set: {"abc", "xyz", "123"}>]
+      #
+      # @see http://johncarrino.net/blog/2006/08/11/powerset-in-ruby/
+      #
+      def powerset
+        inject([self.class.new]) do |power_set,element|
+          sub_set = []
+
+          power_set.each do |i|
+            sub_set << i
+            sub_set << i + [element]
+          end
+
+          sub_set
+        end
+      end
+
+      alias cartesian_product powerset
+
+    end
+  end
+end

data/spec/.rspec

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

data/spec/combinatorics_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe "Combinatorics" do
+end

data/spec/list_comprehension_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'combinatorics/list_comprehension'
+
+describe "Array#comprehension" do
+  it "should return an Enumerator object if no block is given" do
+    a = [1..5]
+
+    a.comprehension.should_not be_kind_of(Array)
+  end
+
+  it "should yield iterations to the given block" do
+    range = (1..5)
+    a = [range]
+
+    a.comprehension.to_a.should == [[1],[2],[3],[4],[5]]
+  end
+
+  it "should do nothing an Array of all non-enumerable objects" do
+    a = [1,2,3]
+
+    a.comprehension.to_a.should == [a]
+  end
+
+  it "should pass through an empty Array" do
+    a = []
+
+    a.comprehension.to_a.should == [a]
+  end
+
+  it "should iterate over the values within an enumerable value" do
+    range = (1..10)
+    a = [range]
+
+    a.comprehension.to_a.should == [[1],[2],[3],[4],[5],[6],[7],[8],[9],[10]]
+  end
+
+  it "should ignore non-enumerable values" do
+    range = (1..5)
+    a = [1,range]
+
+    a.comprehension.to_a.should == [[1,1],[1,2],[1,3],[1,4],[1,5]]
+  end
+end

data/spec/power_set/array_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'combinatorics/power_set/extensions/array'
+require 'power_set/mixin_examples'
+
+describe Array do
+  subject { Array }
+
+  it_should_behave_like "Combinatorics::PowerSet::Mixin"
+end

data/spec/power_set/mixin_examples.rb

@@ -0,0 +1,25 @@
+shared_examples_for "Combinatorics::PowerSet::Mixin" do
+  it "the powerset of an empty Set should only contain the empty Set" do
+    set = subject[]
+
+    set.powerset.should == [set]
+  end
+
+  it "the powerset of a single Set should contain that Set" do
+    set = subject[1]
+
+    set.powerset.should == [subject[], set]
+  end
+
+  it "the powerset of a Set should all be subsets" do
+    set = subject[1,2,3]
+
+    set.powerset.each { |subset| (set & subset).should == subset }
+  end
+
+  it "should alias cartesian_product to powerset" do
+    set = subject[1,2,3]
+
+    set.cartesian_product.should == set.powerset
+  end
+end

data/spec/power_set/set_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'combinatorics/power_set/extensions/set'
+require 'power_set/mixin_examples'
+
+describe Set do
+  subject { Set }
+
+  it_should_behave_like "Combinatorics::PowerSet::Mixin"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+
+gem 'rspec', '>= 1.3.0'
+require 'spec'

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: combinatorics
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :development
+  version_requirements: *id003
+description: A collection of modules and methods for performing Combinatoric calculations.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .gitignore
+- .specopts
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- combinatorics.gemspec
+- lib/combinatorics.rb
+- lib/combinatorics/list_comprehension.rb
+- lib/combinatorics/power_set.rb
+- lib/combinatorics/power_set/extensions.rb
+- lib/combinatorics/power_set/extensions/array.rb
+- lib/combinatorics/power_set/extensions/set.rb
+- lib/combinatorics/power_set/mixin.rb
+- spec/.rspec
+- spec/combinatorics_spec.rb
+- spec/list_comprehension_spec.rb
+- spec/power_set/array_spec.rb
+- spec/power_set/mixin_examples.rb
+- spec/power_set/set_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/postmodern/combinatorics
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Bringing (more) Combinatorics to Ruby
+test_files: 
+- spec/combinatorics_spec.rb
+- spec/list_comprehension_spec.rb
+- spec/spec_helper.rb
+- spec/power_set/set_spec.rb
+- spec/power_set/array_spec.rb
+- spec/power_set/mixin_examples.rb