combinatorics 0.1.0 → 0.2.0

data/.document

@@ -1,11 +1,10 @@
 # .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
+LICENSE.md
+README.md
+ChangeLog.md

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.2.0 / 2010-10-03
+
+* Added {Range#&}.
+* Added {Range#upto}.
+* Added {Range#downto}.
+
 ### 0.1.0 / 2010-10-02
 
 * Initial release:

data/README.md

@@ -12,6 +12,7 @@ A collection of modules and methods for performing
 ## Features
 
 * Adds `powerset` to {Array} and {Set}.
+* Added {Range#&}, {Range#upto} and {Range#downto}.
 * Adds Haskell/Python style list comprehensions via {Array#comprehension}.
 
 ## Examples
@@ -50,6 +51,17 @@ Power-set of a {Set}:
           #<Set: {"ab", "cd"}>,
           #<Set: {"ab", "cd", "ef"}>]
 
+Find the intersecting sub-range between two ranges:
+
+    (1..50) & (20..100)
+    # => (20..50)
+
+Enumerate over every sub-range between two ranges:
+
+    (1..5).upto(2..10).to_a
+    # => [1..5, 1..6, 1..7, 1..8, 1..9, 1..10,
+          2..5, 2..6, 2..7, 2..8, 2..9, 2..10]
+
 List comprehensions:
 
     require 'combinatorics/list_comprehension'

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/combinatorics.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{combinatorics}
-  s.version = "0.1.0"
+  s.version = "0.2.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.date = %q{2010-10-03}
   s.description = %q{A collection of modules and methods for performing Combinatoric calculations.}
   s.email = %q{postmodern.mod3@gmail.com}
   s.extra_rdoc_files = [
@@ -29,6 +29,8 @@ Gem::Specification.new do |s|
      "VERSION",
      "combinatorics.gemspec",
      "lib/combinatorics.rb",
+     "lib/combinatorics/extensions.rb",
+     "lib/combinatorics/extensions/range.rb",
      "lib/combinatorics/list_comprehension.rb",
      "lib/combinatorics/power_set.rb",
      "lib/combinatorics/power_set/extensions.rb",
@@ -37,6 +39,7 @@ Gem::Specification.new do |s|
      "lib/combinatorics/power_set/mixin.rb",
      "spec/.rspec",
      "spec/combinatorics_spec.rb",
+     "spec/extensions/range_spec.rb",
      "spec/list_comprehension_spec.rb",
      "spec/power_set/array_spec.rb",
      "spec/power_set/mixin_examples.rb",
@@ -51,6 +54,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/combinatorics_spec.rb",
      "spec/list_comprehension_spec.rb",
+     "spec/extensions/range_spec.rb",
      "spec/spec_helper.rb",
      "spec/power_set/set_spec.rb",
      "spec/power_set/array_spec.rb",

data/lib/combinatorics.rb

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

data/lib/combinatorics/extensions.rb

@@ -0,0 +1 @@
+require 'combinatorics/extensions/range'

data/lib/combinatorics/extensions/range.rb

@@ -0,0 +1,97 @@
+class Range
+
+  #
+  # Finds the intersecting sub-range.
+  #
+  # @param [Range] other
+  #   The other range.
+  #
+  # @return [Range]
+  #   The intersecting sub-range.
+  #
+  # @example
+  #   (1..100) & (20..200)
+  #   # => 20..100
+  #
+  # @since 0.2.0
+  #
+  def &(other)
+    Range.new(
+      [self.first, other.first].max,
+      [self.last, other.last].min
+    )
+  end
+  
+  #
+  # Iterates over every sub-range up to the other range.
+  #
+  # @param [Range] other
+  #   The upper bounding range.
+  #
+  # @yield [subrange]
+  #   The given block will be passed every sub-range between the two ranges.
+  #
+  # @yieldparam [Range] subrange
+  #   A sub-range bounded by the beginning of the range and the ending of
+  #   the other range.
+  #
+  # @return [Enumerator]
+  #   If no block is given, an enumerator object will be returned.
+  #
+  # @example
+  #   (1..5).upto(2..7).to_a
+  #   # => [1..5, 1..6, 1..7, 2..5, 2..6, 2..7]
+  #
+  # @since 0.2.0
+  #
+  def upto(other)
+    return enum_for(:upto,other) unless block_given?
+
+    unless other.kind_of?(Range)
+      raise(TypeError,"bad value for range",caller)
+    end
+
+    self.first.upto(other.first) do |start|
+      self.last.upto(other.last) do |stop|
+        yield (start..stop)
+      end
+    end
+  end
+
+  #
+  # Iterates over every sub-range down to the other range.
+  #
+  # @param [Range] other
+  #   The lower bounding range.
+  #
+  # @yield [subrange]
+  #   The given block will be passed every sub-range between the two ranges.
+  #
+  # @yieldparam [Range] subrange
+  #   A sub-range bounded by the beginning of the other range and the
+  #   ending of the range.
+  #
+  # @return [Enumerator]
+  #   If no block is given, an enumerator object will be returned.
+  #
+  # @example
+  #   (2..7).downto(1..5).to_a
+  #   # => [2..7, 2..6, 2..5, 1..7, 1..6, 1..5]
+  #
+  # @since 0.2.0
+  #
+  def downto(other)
+    return enum_for(:downto,other) unless block_given?
+
+    unless other.kind_of?(Range)
+      raise(TypeError,"bad value for range",caller)
+    end
+
+    self.first.downto(other.first) do |start|
+      self.last.downto(other.last) do |stop|
+        yield (start..stop)
+      end
+    end
+  end
+
+end

data/lib/combinatorics/power_set/mixin.rb

@@ -4,6 +4,13 @@ module Combinatorics
       #
       # Calculates the power-set of an Enumerable object.
       #
+      # @yield [subset]
+      #   If a block is given, it will be passed each sub-set from the
+      #   power-set.
+      #
+      # @yieldparam [Array] subset
+      #   A sub-set from the power-set.
+      #
       # @return [Array]
       #   The power set.
       #
@@ -24,9 +31,12 @@ module Combinatorics
         inject([self.class.new]) do |power_set,element|
           sub_set = []
 
-          power_set.each do |i|
-            sub_set << i
-            sub_set << i + [element]
+          power_set.each do |previous_set|
+            new_set = previous_set + [element]
+            yield new_set if block_given?
+
+            sub_set << previous_set
+            sub_set << new_set
           end
 
           sub_set

data/spec/extensions/range_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'combinatorics/extensions/range'
+
+describe Range do
+  describe "&" do
+    it "should pick the maximum beginning value" do
+      ((100..200) & (150..200)).first.should == 150
+    end
+
+    it "should pick the mimum ending value" do
+      ((100..150) & (100..200)).last.should == 150
+    end
+  end
+
+  describe "upto" do
+    subject { 1..10 }
+
+    it "should iterate over every beginning value" do
+      subject.upto(5..10).to_a.should == [
+        (1..10),
+        (2..10),
+        (3..10),
+        (4..10),
+        (5..10)
+      ]
+    end
+
+    it "should iterate over every ending value" do
+      subject.upto(1..15).to_a.should == [
+        (1..10),
+        (1..11),
+        (1..12),
+        (1..13),
+        (1..14),
+        (1..15)
+      ]
+    end
+
+    it "should not iterate up to lower bounding ranges" do
+      subject.upto(0..5).to_a.should be_empty
+    end
+  end
+
+  describe "downto" do
+    subject { 5..15 }
+
+    it "should iterate over every beginning value" do
+      subject.downto(1..15).to_a.should == [
+        (5..15),
+        (4..15),
+        (3..15),
+        (2..15),
+        (1..15)
+      ]
+    end
+
+    it "should iterate over every ending value" do
+      subject.downto(5..10).to_a.should == [
+        (5..15),
+        (5..14),
+        (5..13),
+        (5..12),
+        (5..11),
+        (5..10)
+      ]
+    end
+
+    it "should not iterate down to upward bounding ranges" do
+      subject.downto(10..20).to_a.should be_empty
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-02 00:00:00 -07:00
+date: 2010-10-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,6 +84,8 @@ files:
 - VERSION
 - combinatorics.gemspec
 - lib/combinatorics.rb
+- lib/combinatorics/extensions.rb
+- lib/combinatorics/extensions/range.rb
 - lib/combinatorics/list_comprehension.rb
 - lib/combinatorics/power_set.rb
 - lib/combinatorics/power_set/extensions.rb
@@ -92,6 +94,7 @@ files:
 - lib/combinatorics/power_set/mixin.rb
 - spec/.rspec
 - spec/combinatorics_spec.rb
+- spec/extensions/range_spec.rb
 - spec/list_comprehension_spec.rb
 - spec/power_set/array_spec.rb
 - spec/power_set/mixin_examples.rb
@@ -132,6 +135,7 @@ summary: Bringing (more) Combinatorics to Ruby
 test_files: 
 - spec/combinatorics_spec.rb
 - spec/list_comprehension_spec.rb
+- spec/extensions/range_spec.rb
 - spec/spec_helper.rb
 - spec/power_set/set_spec.rb
 - spec/power_set/array_spec.rb