combinatorics 0.3.1 → 0.4.1

data/Rakefile

@@ -2,28 +2,39 @@ require 'rubygems'
 require 'rake'
 
 begin
+  gem 'ore-tasks', '~> 0.4'
   require 'ore/tasks'
+
   Ore::Tasks.new
 rescue LoadError => e
-  STDERR.puts e.message
-  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+  warn e.message
+  warn "Run `gem install ore-tasks` to install 'ore/tasks'."
 end
 
 begin
+  gem 'rspec', '~> 2.4'
   require 'rspec/core/rake_task'
+
   RSpec::Core::RakeTask.new
 rescue LoadError => e
   task :spec do
     abort "Please run `gem install rspec` to install RSpec."
   end
 end
+task :test => :spec
 task :default => :spec
 
 begin
+  gem 'yard', '~> 0.7'
   require 'yard'
+
   YARD::Rake::YardocTask.new  
 rescue LoadError => e
   task :yard do
     abort "Please run `gem install yard` to install YARD."
   end
 end
+
+task :benchmark do
+  Dir.glob('benchmarks/*.rb') { |script| ruby(script) }
+end

data/benchmarks/cartesian_product.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+lib_dir = File.join(root_dir,'lib')
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'benchmark'
+require 'combinatorics/cartesian_product'
+
+Benchmark.bm(13) do |b|
+  [100, 200, 400, 800].each do |i|
+    n = (1..i).to_a
+
+    b.report("{#{i}} x {#{i}}") do
+      n.cartesian_product(n).to_a
+    end
+  end
+end

data/benchmarks/choose.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+lib_dir = File.join(root_dir,'lib')
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'benchmark'
+require 'combinatorics/choose'
+
+Benchmark.bm do |b|
+  n     = 20
+  array = (1..n).to_a
+
+  (1..n).each do |i|
+    b.report("n=#{n} k=#{i}") do
+      array.choose(i) { |s| }
+    end
+  end
+end

data/benchmarks/derange.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+lib_dir = File.join(root_dir,'lib')
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'benchmark'
+require 'combinatorics/derange'
+
+Benchmark.bm do |b|
+  (1..10).each do |n|
+    array = (1..n).to_a
+
+    b.report("n=#{n}") do
+      array.derange { |s| }
+    end
+  end
+end

data/benchmarks/list_comprehension.rb

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 root_dir = File.expand_path(File.join(File.dirname(__FILE__),'..'))
 lib_dir = File.join(root_dir,'lib')
 $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
@@ -9,14 +7,13 @@ require 'combinatorics/list_comprehension'
 
 Benchmark.bm(12) do |b|
   singleton_list = ([1] * 500)
-  single_enum_list = [1..200, 1]
-  depth_list = [1..200]
+  single_enum_list = [1..100, 1]
+  depth_list = [1..100]
 
   b.report('singleton:') do
     singleton_list.comprehension.each { |list| list.last }
   end
 
-
   b.report('single-enum:') do
     single_enum_list.comprehension.each { |list| list.last }
   end

data/benchmarks/permute.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+lib_dir = File.join(root_dir,'lib')
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'benchmark'
+require 'combinatorics/permute'
+
+Benchmark.bm do |b|
+  array = (1..10).to_a
+
+  (1..10).each do |n|
+    b.report("r=#{n}") do
+      array.permute(n) { |s| }
+    end
+  end
+end

data/benchmarks/power_set.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+lib_dir = File.join(root_dir,'lib')
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'benchmark'
+require 'combinatorics/power_set'
+
+Benchmark.bm do |b|
+  (10..20).each do |n|
+    array = (1..n).to_a
+
+    b.report("n=#{n}") do
+      array.power_set { |s| }
+    end
+  end
+end

data/combinatorics.gemspec

@@ -1,10 +1,127 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
-begin
-  Ore::Specification.new do |gemspec|
-    # custom logic here
+require 'yaml'
+
+Gem::Specification.new do |gemspec|
+  files = if File.directory?('.git')
+            `git ls-files`.split($/)
+          elsif File.directory?('.hg')
+            `hg manifest`.split($/)
+          elsif File.directory?('.svn')
+            `svn ls -R`.split($/).select { |path| File.file?(path) }
+          else
+            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+          end
+
+  filter_files = lambda { |paths|
+    case paths
+    when Array
+      (files & paths)
+    when String
+      (files & Dir[paths])
+    end
+  }
+
+  version = {
+    :file => 'lib/combinatorics/version.rb',
+    :constant => 'Combinatorics::VERSION'
+  }
+
+  defaults = {
+    'name' => File.basename(File.dirname(__FILE__)),
+    'files' => files,
+    'executables' => filter_files['bin/*'].map { |path| File.basename(path) },
+    'test_files' => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
+    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
+  }
+
+  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+
+  gemspec.name = metadata.fetch('name',defaults[:name])
+  gemspec.version = if metadata['version']
+                      metadata['version']
+                    elsif File.file?(version[:file])
+                      require File.join('.',version[:file])
+                      eval(version[:constant])
+                    end
+
+  gemspec.summary = metadata.fetch('summary',metadata['description'])
+  gemspec.description = metadata.fetch('description',metadata['summary'])
+
+  case metadata['license']
+  when Array
+    gemspec.licenses = metadata['license']
+  when String
+    gemspec.license = metadata['license']
+  end
+
+  case metadata['authors']
+  when Array
+    gemspec.authors = metadata['authors']
+  when String
+    gemspec.author = metadata['authors']
+  end
+
+  gemspec.email = metadata['email']
+  gemspec.homepage = metadata['homepage']
+
+  case metadata['require_paths']
+  when Array
+    gemspec.require_paths = metadata['require_paths']
+  when String
+    gemspec.require_path = metadata['require_paths']
+  end
+
+  gemspec.files = filter_files[metadata['files']]
+
+  gemspec.executables = metadata['executables']
+  gemspec.extensions = metadata['extensions']
+
+  if Gem::VERSION < '1.7.'
+    gemspec.default_executable = gemspec.executables.first
+  end
+
+  gemspec.test_files = filter_files[metadata['test_files']]
+
+  unless gemspec.files.include?('.document')
+    gemspec.extra_rdoc_files = metadata['extra_doc_files']
+  end
+
+  gemspec.post_install_message = metadata['post_install_message']
+  gemspec.requirements = metadata['requirements']
+
+  if gemspec.respond_to?(:required_ruby_version=)
+    gemspec.required_ruby_version = metadata['required_ruby_version']
+  end
+
+  if gemspec.respond_to?(:required_rubygems_version=)
+    gemspec.required_rubygems_version = metadata['required_rubygems_version']
+  end
+
+  parse_versions = lambda { |versions|
+    case versions
+    when Array
+      versions.map { |v| v.to_s }
+    when String
+      versions.split(/,\s*/)
+    end
+  }
+
+  if metadata['dependencies']
+    metadata['dependencies'].each do |name,versions|
+      gemspec.add_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['runtime_dependencies']
+    metadata['runtime_dependencies'].each do |name,versions|
+      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['development_dependencies']
+    metadata['development_dependencies'].each do |name,versions|
+      gemspec.add_development_dependency(name,parse_versions[versions])  
+    end
   end
-rescue NameError
-  STDERR.puts "The 'combinatorics.gemspec' file requires Ore."
-  STDERR.puts "Run `gem install ore` to install Ore."
 end

data/gemspec.yml

@@ -4,13 +4,18 @@ description:
   A collection of modules and methods for performing Combinatoric
   calculations.
 license: MIT
-authors: Postmodern
-email: postmodern.mod3@gmail.com
+authors:
+ - Postmodern
+ - Duper
+email:
+ - postmodern.mod3@gmail.com
+ - super@manson.vistech.net
 homepage: http://github.com/postmodern/combinatorics
 has_yard: true
 
+required_ruby_version: ">= 1.8.7"
+
 development_dependencies:
-  ore: ~> 0.1.0
-  ore-tasks: ~> 0.1.0
-  rspec: ~> 2.0.0
-  yard: ~> 0.6.0
+  ore-tasks: ~> 0.4
+  rspec: ~> 2.4
+  yard: ~> 0.7

data/lib/combinatorics.rb

@@ -1,4 +1,11 @@
+require 'combinatorics/cartesian_product'
+require 'combinatorics/choose'
+require 'combinatorics/derange'
 require 'combinatorics/extensions'
 require 'combinatorics/list_comprehension'
 require 'combinatorics/power_set'
+require 'combinatorics/permute'
 require 'combinatorics/version'
+
+# @todo inversions (permutation mutations)
+# @todo set families (approximate power set subsets)

data/lib/combinatorics/cartesian_product.rb

@@ -0,0 +1,3 @@
+require 'combinatorics/cartesian_product/mixin'
+require 'combinatorics/cartesian_product/extensions'
+require 'combinatorics/cartesian_product/cardinality'

data/lib/combinatorics/cartesian_product/cardinality.rb

@@ -0,0 +1,45 @@
+module Combinatorics
+  #
+  # @author duper <super@manson.vistech.net>
+  #
+  # @since 0.4.0
+  #
+  module CartesianProduct
+    #
+    # Wrapper for Cartesian product cardinality method defined above
+    #
+    # @param [Fixnum] a
+    #   Cardinality of first set.
+    #
+    # @param [Fixnum] b
+    #   Cardinality of second set.
+    #
+    # @raise [RangeError]
+    #   Inputs must be greater than zero.
+    #
+    # @return [Fixnum]
+    #   Length of enumeration resulting from a Cartesian product.
+    #
+    # @example Calculate elements in Cartesian product of two equal-size sets
+    #   cardinality(3, 4) 
+    #   # => 12
+    # 
+    def self.cardinality(a,b)
+      if (a <= 0 || b <= 0)
+        raise(RangeError,"inputs must be greater than zero")
+      end
+
+      a * b
+    end
+
+    #
+    # @note The letter `X' is scholastic notation for the Cartesian product
+    #       set operation
+    #
+    # @see cardinality
+    #
+    def self.X(a,b)
+      cardinality(a,b)
+    end
+  end
+end

data/lib/combinatorics/cartesian_product/extensions.rb

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

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

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

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

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

data/lib/combinatorics/cartesian_product/mixin.rb

@@ -0,0 +1,57 @@
+require 'combinatorics/list_comprehension'
+
+module Combinatorics
+  module CartesianProduct
+    #
+    # @author duper <super@manson.vistech.net>
+    #
+    # @since 0.4.0
+    #
+    module Mixin
+      #
+      # Calculates the Cartesian product of an Enumerable object.
+      #
+      # @yield [subset]
+      #   If a block is given, it will be passed each individual subset
+      #   element from the Cartesian product set as a whole.
+      #
+      # @yieldparam [Array] subset
+      #   The sub-set from the Cartesian product.
+      #
+      # @return [Enumerator]
+      #   Resulting Cartesian product set.
+      #
+      # @raise [TypeError]
+      #   `other` must be Enumerable.
+      #
+      # @example Cartesian product of an Array
+      #   [1, 2].cartesian_product([3, 4])
+      #   # => [[1, 3], [2, 3], [1, 4], [2, 4]]
+      #
+      # @example Cartesian product over an Array of Strings
+      #   ['a'].cartesian_product(['b', 'c', 'd']).to_a
+      #   # => [["a", "b"], ["a", "c"], ["a", "d"]]
+      #
+      # @example Three-way Cartesian product operation
+      #   [0, 1].cartesian_product([2, 3], [4, 5]).to_a
+      #   # => [
+      #   #      [0, 2, 4], [0, 2, 5], [0, 3, 4], [0, 3, 5],
+      #   #      [1, 2, 4], [1, 2, 5], [1, 3, 4], [1, 3, 5],
+      #   #    ]
+      #   
+      # @see http://en.wikipedia.org/wiki/Cartesian_product
+      #
+      def cartesian_product(*others,&block)
+        return enum_for(:cartesian_product,*others) unless block
+
+        # a single empty Set will result in an empty Set
+        return nil if (empty? || others.any?(&:empty?))
+
+        Array[self,*others].comprehension(&block)
+      end
+
+      alias cartprod  cartesian_product
+      alias cartesian cartesian_product
+    end
+  end
+end