range-bisect 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in range-bisect.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan Biesemeyer
+
+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,84 @@
+# Range::Bisect
+
+Given a `Range` of `Integer`s, find by bisection the Integers who satisfy
+a given block.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'range-bisect'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install range-bisect
+
+## Usage
+
+Usage is best-served by an example.
+
+Suppose a limited external service allows you to specify a range of integers,
+and will tell you whether or not that range contains one or more things that
+you are looking for.
+
+```ruby
+# Here is a haystack implementation.
+# We can only use its interface.
+class Haystack
+  # @param range [Range<Integer>]
+  # @return [Boolean]
+  def has_needles?(range)
+    # ...
+  end
+end
+
+# suppose we have an instance of that, called haystack
+haystack
+# and we know that somewhere between 0 and 100, 
+# it includes one or more needles
+haystack.has_needles?(0...100) #=> true
+
+# but we can only know whether or not a range has needles,
+# not how many there are or where they are.
+haystack.has_needle?(0..0) #=> false
+haystack.has_needle?(1..1) #=> false
+haystack.has_needle?(2..2) #=> false
+haystack.has_needle?(3..3) #=> false
+ # ...
+haystack.has_needle?(99..99) #=> false
+
+# Let's try the same thing with iteration
+(0..100).to_a.select do |idx|
+  haystack.has_needle?(idx..idx)
+end
+# => [17, 47, 99]
+
+# Note that we still had to query every single item.
+# Imagine a haystack with a billion items; whether
+# it has one or a billion needles, you must query it
+# a billion times.
+
+# Bisect improves the best-case scenario using a 
+# divide-and-conquer method. It splits the search range
+# recursively, continuing to search into sub-ranges that
+# return true for the given block.
+search_range = 0...100
+search_range.extend(Range::Bisect)
+search_range.bisect do |sub_range|
+  haystack.has_needle?(sub_range)
+end
+# => [17, 47, 99]
+
+```
+
+## 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,9 @@
+# encoding: utf-8
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.verbose = true
+end

data/lib/range-bisect.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'range/bisect'

data/lib/range/bisect.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+require 'range/bisect/version'
+
+module Range::Bisect
+  # Extends Range::Bisect into a duplicate of integer_range,
+  # then calls #bisect.
+  #
+  # @param integer_range [Range<Integer>]
+  # @yieldparam [Range<Integer>]
+  # @yieldreturn [Boolean]
+  def self.bisect(integer_range, &block)
+    source = integer_range.dup
+    source.extend(self) unless source.kind_of?(Range::Bisect)
+    source.bisect(&block)
+  end
+
+  # By bisection, find all of the elements in this range
+  # that cause the block to return true. It is especially
+  # important to note that the given block must operate with
+  # the whole range, not simply its beginning or end.
+  #
+  # @yieldparam [Range<Integer>]
+  # @yieldreturn [Boolean]
+  def bisect(&block)
+    ensure_integer_range!
+
+    return [] unless yield(self)
+
+    if first(2).size == 1 # determine if single-element without #to_a
+      return [first]
+    else
+      bisection.map do |range|
+        Range::Bisect.bisect(range, &block)
+      end.flatten.sort
+    end
+  end
+
+  private
+
+  # Ensure that self is a [Range<Integer>]
+  # @raise [ArgumentError] if self is not [Range<Integer>].
+  def ensure_integer_range!
+    unless self.kind_of?(Range) &&
+           self.first.kind_of?(Integer) &&
+           self.last.kind_of?(Integer)
+      raise ArgumentError, "Not a Range<Integer>: #{self}"
+    end
+  end
+
+  # splits self in two
+  # @return [Array<Range<Integer>>]
+  def bisection
+    size = self.end - self.begin
+    midpoint = self.begin + (size / 2)
+
+    first_half = Range.new(self.begin, midpoint, false)
+    last_half = Range.new(midpoint.next, self.end, exclude_end?)
+
+    [first_half, last_half]
+  end
+end

data/lib/range/bisect/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module Range::Bisect
+  VERSION = '0.0.1'
+end

data/range-bisect.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'range/bisect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'range-bisect'
+  spec.version       = Range::Bisect::VERSION
+  spec.authors       = ['Ryan Biesemeyer']
+  spec.email         = ['ryan@yaauie.com']
+  spec.description   = 'Bisect a range, finding elements that match the block'
+  spec.summary       = 'Adds Range::Bisect, which can be used to ' +
+                       'find by bisection'
+  spec.homepage      = 'https://github.com/yaauie/range-bisect'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/spec/range/bisect_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'range/bisect'
+
+describe Range::Bisect do
+  let(:needles) { [1, 3, 9, 5, 11] }
+  let(:needle_finder) do
+    proc { |haystack| haystack.any? { |elem| needles.include?(elem) } }
+  end
+  let(:haystack) do
+    (1...12)
+  end
+  subject { Range::Bisect.bisect(haystack, &needle_finder) }
+
+  it { should == needles.sort }
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: range-bisect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Biesemeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bisect a range, finding elements that match the block
+email:
+- ryan@yaauie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/range-bisect.rb
+- lib/range/bisect.rb
+- lib/range/bisect/version.rb
+- range-bisect.gemspec
+- spec/range/bisect_spec.rb
+homepage: https://github.com/yaauie/range-bisect
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds Range::Bisect, which can be used to find by bisection
+test_files:
+- spec/range/bisect_spec.rb
+has_rdoc: