huge_enumerable 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+InstalledFiles
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Frank Hall
+
+MIT License
+
+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,29 @@
+# HugeEnumerable
+
+Enumerate, sample, shuffle, combine, permutate, and create products of massive data sets using minimal memory
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'huge_enumerable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install huge_enumerable
+
+## Usage
+
+See HugeCollection, HugeCombination, HugePermutation, and HugeProduct for ways of utilizing HugeEnumerable.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rdoc/task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include 'README.md', "lib/**/*\.rb"
+
+  rdoc.options << '--line-numbers'
+end
+

data/huge_enumerable.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'huge_enumerable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "huge_enumerable"
+  spec.version       = HugeEnumerable::VERSION
+  spec.authors       = ["Frank Hall"]
+  spec.email         = ["ChapterHouse.Dune@gmail.com"]
+  spec.description   = %q{Enumerate, sample, shuffle, combine, permutate, and create products of massive data sets using minimal memory}
+  spec.summary       = %q{Enumerate, sample, shuffle, combine, permutate, and create products of massive data sets using minimal memory}
+  spec.homepage      = "https://github.com/ChapterHouse/huge_enumerable.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_development_dependency 'rdoc'
+  spec.add_runtime_dependency "backports" # Wish this could be conditional. It is only used for ruby 1.8 for as long as I support it.
+  spec.add_runtime_dependency "prime_miller_rabin", ">= 0.0.2"
+
+end

data/lib/huge_enumerable/huge_collection.rb

@@ -0,0 +1,83 @@
+require 'huge_enumerable'
+# The simplest form of a HugeEnumerable.
+# This class can be used for large arrays or anything else that responds to [].
+# It is not necessary for the enumerable to be completely mapped into memory.
+# It only has to be able to return the element mapped to the index given to [].
+# ==== Examples
+#
+# Using HugeCollection directly:
+#
+#    original_array = ('a'..'z').to_a
+#    collection = HugeCollection.new(original_array)
+#    collection.shuffle!
+#    original_array[0..4] # => ["a", "b", "c", "d", "e"]
+#    collection[0..4] # => ["j", "a", "r", "i", "z"]
+#
+#
+# Subclassing HugeCollection
+#
+#    class StringNext < HugeCollection
+#
+#      def initialize(size)
+#        @collection_size = size
+#        super ('a'..'z').to_a
+#      end
+#
+#      private
+#
+#      def fetch(index)
+#        result = ""
+#        index += 1
+#        while index > 0
+#          index -= 1
+#          result.prepend super(index % 26)
+#          index /= 26
+#        end
+#        result
+#      end
+#
+#    end
+#
+#    googol = 10*100
+#    collection = StringNext.new(googol)
+#    collection.size # => 10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+#    collection[0]          # => "a"
+#    collection[-1]         # => "zhxrtplbmwaiwcqlzpmglpziaegsdivmbvlnssusbjtbcgywaycqnhxztqwwikxvrsptazpp"
+#    collection[googol / 2] # => "dlijhfafxmqxnusmhfpshmdmopvodxfnkfgivwvnejaapyxmynutdlmjhxxqrykiiuizzhi"
+#    collection.shuffle!
+#    collection[0]          # => "bipzqqzayczkgsmaseflwktpsotzclcjsqlnnjaciaawufpojywxflknuddhqkilhoedacn"
+#    collecyion[-1]         # => "etneuebyurxgrvrfsreesxuvjaiyoqwplofsptacjdbhuhafdiwbwujvniokltgkjbfkiuy"
+class HugeCollection < HugeEnumerable
+
+  # Create a new HugeCollection
+  #
+  # ==== Attributes
+  #
+  # * +enumerable+ - Any enumerable that responds to []
+  #
+  # ==== Options
+  #
+  # * +:max_array_size+ - The default size of arrays when #to_a is called.
+  # * +:rng+ - The random number generator to use.
+  def initialize(enumerable, max_array_size = nil, rng = nil)
+    @enum = enumerable
+    super(max_array_size, rng)
+  end
+
+  private
+
+  attr_accessor :enum
+
+  def collection_size
+    @collection_size ||= enum_size
+  end
+
+  def enum_size
+    @enum_size ||= enum.size
+  end
+
+  def fetch(index)
+    enum[index]
+  end
+
+end

data/lib/huge_enumerable/huge_combination.rb

@@ -0,0 +1,118 @@
+require 'huge_enumerable'
+# HugeCombination is a HugeEnumerable style combination. Comparable to Array#combination.
+# This class can be used to generate combinations of large arrays or anything else that responds to [].
+# It is not necessary for the enumerable to be completely mapped into memory.
+# It only has to be able to return the element mapped to the index given to [].
+# ==== Examples
+#
+# Using HugeCombination directly:
+#
+#    combination = HugeCombination.new(('a'..'z').to_a, 2)
+#    combination[0..4] # => [["a", "b"], ["a", "c"], ["a", "d"], ["a", "e"], ["a", "f"]]
+#    combination[23..27] # => [["a", "y"], ["a", "z"], ["b", "c"], ["b", "d"], ["b", "e"]]
+#
+#
+# Subclassing HugeCombination
+#
+#    class NumberArray < HugeCollection
+#
+#      def initialize(size)
+#        @collection_size = size
+#        super(nil)
+#      end
+#
+#      private
+#
+#      def fetch(index)
+#        index
+#      end
+#
+#    end
+#
+#    class NumberCombination < HugeCombination
+#
+#      def initialize(size)
+#        enumerable = size < 10 ? (0...size).to_a : NumberArray.new(size)
+#        super enumerable, 2, nil, nil
+#      end
+#
+#      private
+#
+#      def fetch(index)
+#        array = super
+#        sum = array.inject(0) { |sum, i| sum += i }
+#        "#{array.first} + #{array.last} = #{sum}"
+#      end
+#
+#    end
+#
+#    combination = NumberCombination.new(10**30)
+#    size = combination.size # => 499999999999999999999999999999500000000000000000000000000000
+#    combination[0]          # => "0 + 1 = 1"
+#    combination[-1]         # => "999999999999999999999999999998 + 999999999999999999999999999999 = 1999999999999999999999999999997"
+#    combination[size / 2]   # => "292893218813452475599155637895 + 296085173605458049080913472356 = 588978392418910524680069110251"
+class HugeCombination < HugeCollection
+
+  # Create a new HugeCombination
+  #
+  # ==== Attributes
+  #
+  # * +enumerable+ - Any enumerable that responds to []
+  # * +size+ - The number of elements per combination to use from enumerable. (Currently only size 2 is supported)
+  #
+  # ==== Options
+  #
+  # * +:max_array_size+ - The default size of arrays when #to_a is called.
+  # * +:rng+ - The random number generator to use.
+  def initialize(enumerable, size, max_array_size = nil, rng = nil)
+    raise NotImplementedError, "Not yet implemented for any size != 2" if size != 2 # TODO: Extend this class to handle length N
+    @combination_size = size
+    super(enumerable, max_array_size, rng)
+  end
+
+  private
+
+  def collection_size
+    sum(enum_size - 1)
+  end
+
+  def fetch(index)
+    cycle = locate_cycle(index)
+    first_index = cycle - 1
+    max_cycles = enum_size - 1
+    used = (cycle - 1) == 0 ? 0 : sum_from(max_cycles, max_cycles - (cycle - 2))
+    second_index = index - used + cycle
+    [enum[first_index], enum[second_index]]
+  end
+
+  def locate_cycle(index, min=0, max=enum_size-1)
+    cycle = min + (max - min) / 2
+
+    check_high = sum_at_cycle(cycle)
+    check_low = sum_at_cycle(cycle - 1)
+
+    if check_high > index && check_low <= index
+      cycle
+    elsif check_low > index
+      locate_cycle(index, min, cycle-1)
+    else
+      locate_cycle(index, cycle+1, max)
+    end
+  end
+
+  def sum(x)
+    x * (x + 1) / 2
+  end
+
+  def sum_from(m, n)
+    m, n = [n, m] if m > n
+    (n + 1 - m)*(n + m)/2
+  end
+
+  def sum_at_cycle(c)
+    ec = enum_size * c
+    (-c + 2*ec - c**2)/2
+  end
+
+end
+

data/lib/huge_enumerable/huge_permutation.rb

@@ -0,0 +1,67 @@
+require 'huge_enumerable'
+# HugePermutation is a HugeEnumerable style permutation. Comparable to Array#permutation.
+# This class can be used to generate permutations of large arrays or anything else that responds to [].
+# It is not necessary for the enumerable to be completely mapped into memory.
+# It only has to be able to return the element mapped to the index given to [].
+# ==== Examples
+#
+# Using HugePermutation directly:
+#
+#    permutation = HugePermutation.new(('a'..'z').to_a, 2)
+#    permutation[0..4]   # => [["a", "b"], ["a", "c"], ["a", "d"], ["a", "e"], ["a", "f"]]
+#    permutation[23..27] # => [["a", "y"], ["a", "z"], ["b", "a"], ["b", "c"], ["b", "d"]]
+#
+#
+# Subclassing HugePermutation
+#
+#    class SouthernNames < HugePermutation
+#
+#      def initialize
+#        base_names = %w{Bill Joe Jo Bob Mary Lou Betty Sue Jimmy Ann Lee Ruby Jack Belle Daisy Dixie Lynn}
+#        super base_names, 2, nil, nil
+#      end
+#
+#      private
+#
+#      def fetch(index)
+#        "Your southern name is: #{super(index).join(' ')}"
+#      end
+#
+#    end
+#
+#    southern_name = SouthernNames.new
+#    southern_name[0]          # => "Your southern name is: Bill Joe"
+#    southern_name[-1]         # => "Your southern name is: Lynn Dixie"
+#    size = southern_name.size # => 272
+#    southern_name[size / 2]   # => "Your southern name is: Jimmy Ann"
+class HugePermutation < HugeCollection
+
+  # Create a new HugePermutation
+  #
+  # ==== Attributes
+  #
+  # * +enumerable+ - Any enumerable that responds to []
+  # * +size+ - The number of elements per permutation to use from enumerable. (Currently only size 2 is supported)
+  #
+  # ==== Options
+  #
+  # * +:max_array_size+ - The default size of arrays when #to_a is called.
+  # * +:rng+ - The random number generator to use.
+  def initialize(enumerable, length, max_array_size = nil, rng = nil)
+    raise NotImplementedError, "Not yet implemented for any length != 2" if length != 2 # TODO: Extend this class to handle length N
+    super(enumerable, max_array_size, rng)
+  end
+
+  private
+
+  def fetch(x)
+    first_index = x / (enum_size - 1)
+    second_index = ((x % enum_size) + (x / enum_size + 1)) % enum_size
+    [enum[first_index], enum[second_index]]
+  end
+
+  def collection_size
+    enum_size * (enum_size - 1)
+  end
+
+end

data/lib/huge_enumerable/huge_product.rb

@@ -0,0 +1,77 @@
+require 'huge_enumerable'
+# HugePermutation is a HugeEnumerable style product. Comparable to Array#product.
+# This class can be used to generate products of large arrays or anything else that responds to [].
+# It is not necessary for the enumerables to be completely mapped into memory.
+# They only have to be able to return the element mapped to the index given to [].
+# ==== Examples
+#
+# Using HugeProduct directly:
+#
+#    product = HugeProduct.new(('a'..'z').to_a, ('A'..'Z').to_a)
+#    product[0..4]   # => [["a", "A"], ["a", "B"], ["a", "C"], ["a", "D"], ["a", "E"]]
+#    product[23..27] # => [["a", "X"], ["a", "Y"], ["a", "Z"], ["b", "A"], ["b", "B"]]
+#
+#
+# Subclassing HugeProduct
+#
+#    class BabyGirlNames < HugeProduct
+#
+#      def initialize
+#        first_names = %w{Emma Olivia Sophia Isabella Ava Mia Emily Charlotte Ella Amelia Abigail Madison Lily Chloe}
+#        middle_names = %w{Zoe Sophie Evelyn Aubrey Elizabeth Layla Anna Natalie Brooklyn Aria Audrey Ellie Lucy}
+#        super(first_names, middle_names)
+#      end
+#
+#      private
+#
+#      def fetch(index)
+#        super(index).join(' ')
+#      end
+#
+#    end
+#
+#    name = BabyGirlNames.new
+#    name[0]          # => "Emma Zoe"
+#    name[-1]         # => "Chloe Lucy"
+#    size = name.size # => 182
+#    name[size / 2]   # => "Charlotte Zoe"
+class HugeProduct < HugeEnumerable
+
+  # Create a new HugeProduct
+  #
+  # ==== Attributes
+  #
+  # * +enumerable_a+ - Any enumerable that responds to []
+  # * +enumerable_b+ - Any enumerable that responds to [] (This can be the same object as enumerable_a)
+  #
+  # ==== Options
+  #
+  # * +:max_array_size+ - The default size of arrays when #to_a is called.
+  # * +:rng+ - The random number generator to use.
+  def initialize(enumerable_a, enumerable_b, max_array_size = nil, rng = nil)
+    @enum_a = enumerable_a
+    @enum_b = enumerable_b
+    super(max_array_size, rng)
+  end
+
+  private
+
+  attr_accessor :enum_a, :enum_b
+
+  def collection_size
+    enum_a_size * enum_b_size
+  end
+
+  def fetch(x)
+    [enum_a[x / enum_b_size], enum_b[x % enum_b_size]]
+  end
+
+  def enum_a_size
+    @enum_a_size ||= enum_a.size
+  end
+
+  def enum_b_size
+    @enum_b_size ||= enum_b.size
+  end
+
+end

data/lib/huge_enumerable/version.rb

@@ -0,0 +1,4 @@
+class HugeEnumerable
+  # "0.0.1"
+  VERSION = "0.0.1"
+end