cartesian-product 0.1.0

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Art.sy, Inc.
+
+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,49 @@
+cartesian-product
+=================
+
+Ruby's Enumerable.product materializes the entire cartesian product
+of a sequence of arrays into an array of arrays, so a call like:
+
+    [(0..100).to_a, (0..100).to_a, (0..100).to_a].reduce(&:product).map(&:flatten)
+
+actually returns an array of a million elements. This module implements
+an iterator over the cartesian product of an arbitrary number of arrays,
+allowing you to start and stop at a particular index in the lexicographic
+ordering without ever representing the cartesian product in memory.
+
+Quick examples:
+===============
+
+    >> prod = CartesianProduct.new([1,2], [100,101], ['a','b'])
+    >> prod.each { |element| puts element }
+    
+    [1, 100, 'a']
+    [1, 100, 'b']
+    [1, 101, 'a']
+    [1, 101, 'b']
+    [2, 100, 'a']
+    [2, 100, 'b']
+    [2, 101, 'a']
+    [2, 101, 'b']
+
+    >> prod.each(0, 2) { |element| puts element }
+    
+    [1, 100, 'a']
+    [1, 100, 'b']
+    
+    >> prod.each(4, 7) { |element| puts element }
+    
+    [2, 100, 'a']
+    [2, 100, 'b']
+    [2, 101, 'a']
+    
+    >> prod.each(-3, -1) { |element| puts element }
+    
+    [2, 100, 'b']
+    [2, 101, 'a']
+    [2, 101, 'b']
+
+Installation
+============
+
+    gem install cartesian-product

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cartesian-product"
+  gem.homepage = "http://github.com/aaw/cartesian-product"
+  gem.license = "MIT"
+  gem.summary = %Q{A cartesian product implementation in Ruby that doesn't hold the full product in memory}
+  gem.description = %Q{A cartesian product implementation in Ruby that doesn't hold the full product in memory}
+  gem.email = "aaron.windsor@gmail.com"
+  gem.authors = ["Aaron Windsor"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+

data/VERSION

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

data/lib/cartesian-product.rb

@@ -0,0 +1,29 @@
+class CartesianProduct
+  include Enumerable
+
+  def initialize(*arrays)
+    @arrays = arrays.reverse
+    @num_elements = @arrays.inject(1){ |accum, item| accum *= item.length }
+  end
+
+  def count
+    @num_elements
+  end
+
+  def each(start_index=0, stop_index=-1)
+    start_index = @num_elements + start_index if start_index < 0
+    stop_index = @num_elements + stop_index + 1 if stop_index < 0
+    (start_index...stop_index).each { |index| yield(index_to_item(index)) }
+  end
+
+  protected
+
+  def index_to_item(index)
+    @arrays.map do |array|
+      element = array[index % array.length]
+      index /= array.length
+      element
+    end.reverse
+  end
+
+end

data/spec/cartesian-product_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CartesianProduct" do
+  it "behaves correctly when given an empty list" do
+    CartesianProduct.new.to_a.should == [[]]
+  end
+  it "correctly computes the product of  single array" do
+    CartesianProduct.new([1,2,3]).to_a.should == [[1],[2],[3]]
+  end
+  it "correctly computes the product of two arrays" do
+    CartesianProduct.new([1,2,3],['a','b']).to_a.should == [1,2,3].product(['a','b'])
+  end
+  it "correctly computes the product of three arrays" do
+    CartesianProduct.new([1,2], ['a','b','c'], [:d]).to_a.should == [[1,2], ['a','b','c'], [:d]].reduce(&:product).map(&:flatten)
+  end
+  it "handles an empty array mixed with non-empty arrays correctly" do
+    CartesianProduct.new([1,2], ['a','b','c'], []).to_a.should == [[1,2], ['a','b','c'], []].reduce(&:product).map(&:flatten)
+  end
+  it "allows iteration over arbitrary ranges" do
+    prod = CartesianProduct.new([1,2,3], [:four, :five, :size], ['seven', 'eight', 'nine'])
+    collection = []
+    prod.each(0, 2) { |x| collection << x }
+    prod.each(2, 7) { |x| collection << x }
+    prod.each(7, prod.count) { |x| collection << x }
+    prod.to_a.should == collection
+  end
+  it "returns the count of elements in the product" do
+    prod = CartesianProduct.new([1,2,3], [:four], ['five', 'six'])
+    prod.count.should == [1,2,3].length * [:four].length * ['five','six'].length
+  end
+  it "allows indexing using negative numbers" do
+    prod = CartesianProduct.new([1,2,3], [:four], ['five', 'six'])
+    items = []
+    prod.each(0,-1) { |x| items << x }
+    prod.to_a.should == items
+
+    items = []
+    prod.each(0,-2) { |x| items << x }
+    prod.to_a[0..-2].should == items
+
+    items = []
+    prod.each(-5, -3) { |x| items << x }
+    prod.to_a[-5..-3].should == items
+  end
+  it "allows iterating over the same range multiple times" do
+    prod = CartesianProduct.new((0..1000).to_a, (0..1000).to_a, (0..1000).to_a)
+    items_1 = []
+    prod.each(60, 67) { |x| items_1 << x }
+    items_2 = []
+    prod.each(60, 67) { |x| items_2 << x }
+    items_1.should == items_2
+  end
+  it "iterates over the array without materializing it" do
+    results = []
+    CartesianProduct.new((0..1000).to_a, (0..1000).to_a, (0..1000).to_a).each(9000,9002) { |x| results << x }
+    results.length.should == 2
+    results.each{ |result| result.length.should == 3 }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'cartesian-product'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: cartesian-product
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Windsor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2168207780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2168207780
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2168207160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2168207160
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2168206480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2168206480
+description: A cartesian product implementation in Ruby that doesn't hold the full
+  product in memory
+email: aaron.windsor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/cartesian-product.rb
+- spec/cartesian-product_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/aaw/cartesian-product
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4597596894606092724
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A cartesian product implementation in Ruby that doesn't hold the full product
+  in memory
+test_files: []