bisect 0.1

data/.rspec

@@ -0,0 +1 @@
+-r./lib/bisect/core_ext

data/LICENSE.MIT

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Conrad Irwin <conrad@rapportive.com>
+
+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,60 @@
+The bisect gem provides helpers for dealing with sorted Arrays.
+
+Installation
+============
+
+```
+gem install bisect
+```
+
+If you're using Bundler, add `gem 'bisect'` to your Gemfile.
+
+Usage
+=====
+
+There are two functions that you need to know about `Bisect.insort` and `Bisect.bisect`.
+
+`Bisect.insort` adds a new element to the Array, but keeps the Array sorted:
+
+```ruby
+require 'bisect'
+a = [1, 2, 4]
+Bisect.insort(a, 3)
+a == [1, 2, 3, 4]
+```
+
+`Bisect.bisect` gives you the index at which the element would have been inserted:
+
+```ruby
+require 'bisect'
+a = ['a', 'b', 'd']
+Bisect.bisect(a, 'c') == 2
+```
+
+If there are equal elements in the Array then `insort` will insert the element after the last equal element. Similarly `bisect` will return the index one higher than the last equal element. If you'd like to add new elements before equal elements, use `insort_left` and `bisect_left`. If you need to be explicit then `insort_right` and `bisect_right` are aliases for `insort` and `bisect`.
+
+Core ext
+========
+If you want these methods in your Arrays by default, `require 'bisect/core_ext'` If you're using bundler, add `gem 'bisect', :require => 'bisect/core_ext'` to your Gemfile.
+
+```ruby
+require 'bisect/core_ext'
+a = [1, 2, 4]
+a.insort(3)
+a == [1, 2, 3, 4]
+```
+
+Why?
+====
+
+The problem of maintaining a sorted array keeps cropping up, and I like the Python API. As this kind of code has lots of edge-cases, I'm glad the Pythonistas have debugged it already.
+
+Future work
+===========
+
+* Add a subclass of Array that magically stays sorted.
+
+Meta-fu
+=======
+
+Licensed under the MIT license, bug reports and pull requests welcome.

data/bisect.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |gem|
+  gem.name = 'bisect'
+  gem.version = '0.1'
+
+  gem.summary = 'Library for maintaining sorted arrays'
+  gem.description = "A direct port of python's 'bisect' standard library to ruby."
+
+  gem.authors = ['Conrad Irwin']
+  gem.email = %w(conrad.irwin@gmail.com)
+  gem.homepage = 'http://github.com/ConradIrwin/bisect'
+
+  gem.license = 'MIT'
+
+  gem.required_ruby_version = '>= 1.8.7'
+
+  gem.add_development_dependency 'rspec'
+
+  gem.files = `git ls-files`.split("\n")
+end

data/lib/bisect.rb

@@ -0,0 +1,78 @@
+# A direct port of the Python bisect standard library.
+#
+# http://svn.python.org/view/python/branches/py3k/Lib/bisect.py?view=markup&pathrev=70846
+#
+module Bisect
+  class << self
+
+    # Insert item x in list a, and keep it sorted assuming a is sorted.
+    #
+    # If x is already in a, insert it to the right of the rightmost x.
+    #
+    # Optional args lo (default 0) and hi (default len(a)) bound the
+    # slice of a to be searched.
+    def insort_right(a, x, lo=0, hi=a.size)
+      index = bisect_right(a, x, lo, hi)
+      a.insert(index, x)
+    end
+    alias_method :insort, :insort_right
+
+    # Return the index where to insert item x in list a, assuming a is sorted.
+    #
+    # The return value i is such that all e in a[:i] have e <= x, and all e in
+    # a[i:] have e > x.  So if x already appears in the list, a.insert(x) will
+    # insert just after the rightmost x already there.
+    #
+    # Optional args lo (default 0) and hi (default len(a)) bound the
+    # slice of a to be searched.
+    def bisect_right(a, x, lo=0, hi=a.size)
+      raise ArgumentError, "lo must be non-negative" if lo < 0
+
+      while lo < hi
+        mid = (lo + hi) / 2
+        if x < a[mid]
+          hi = mid
+        else
+          lo = mid + 1
+        end
+      end
+
+      lo
+    end
+    alias_method :bisect, :bisect_right
+
+    # Insert item x in list a, and keep it sorted assuming a is sorted.
+    #
+    # If x is already in a, insert it to the left of the leftmost x.
+    #
+    # Optional args lo (default 0) and hi (default len(a)) bound the
+    # slice of a to be searched.
+    def insort_left(a, x, lo=0, hi=a.size)
+      index = bisect_left(a, x, lo, hi)
+      a.insert(index, x)
+    end
+
+    # Return the index where to insert item x in list a, assuming a is sorted.
+    #
+    # The return value i is such that all e in a[:i] have e < x, and all e in
+    # a[i:] have e >= x.  So if x already appears in the list, a.insert(x) will
+    # insert just before the leftmost x already there.
+    #
+    # Optional args lo (default 0) and hi (default len(a)) bound the
+    # slice of a to be searched.
+    def bisect_left(a, x, lo=0, hi=a.size)
+      raise ArgumentError, "lo must be non-negative" if lo < 0
+
+      while lo < hi
+        mid = (lo + hi) / 2
+        if a[mid] < x
+          lo = mid + 1
+        else
+          hi = mid
+        end
+      end
+
+      lo
+    end
+  end
+end

data/lib/bisect/core_ext.rb

@@ -0,0 +1,9 @@
+require 'bisect'
+class Array
+  # Copy all methods from Bisect onto all arrays.
+  Bisect.methods(false).each do |method|
+    define_method(method) do |*args|
+      Bisect.send(method, self, *args)
+    end
+  end
+end

data/spec/bisect_spec.rb

@@ -0,0 +1,115 @@
+# http://svn.python.org/view/python/branches/py3k/Lib/test/test_bisect.py?view=markup&pathrev=70846
+
+describe Bisect do
+  before do
+    @test_cases = [
+      [:right, [], 1, 0],
+      [:right, [1], 0, 0],
+      [:right, [1], 1, 1],
+      [:right, [1], 2, 1],
+      [:right, [1, 1], 0, 0],
+      [:right, [1, 1], 1, 2],
+      [:right, [1, 1], 2, 2],
+      [:right, [1, 1, 1], 0, 0],
+      [:right, [1, 1, 1], 1, 3],
+      [:right, [1, 1, 1], 2, 3],
+      [:right, [1, 1, 1, 1], 0, 0],
+      [:right, [1, 1, 1, 1], 1, 4],
+      [:right, [1, 1, 1, 1], 2, 4],
+      [:right, [1, 2], 0, 0],
+      [:right, [1, 2], 1, 1],
+      [:right, [1, 2], 1.5, 1],
+      [:right, [1, 2], 2, 2],
+      [:right, [1, 2], 3, 2],
+      [:right, [1, 1, 2, 2], 0, 0],
+      [:right, [1, 1, 2, 2], 1, 2],
+      [:right, [1, 1, 2, 2], 1.5, 2],
+      [:right, [1, 1, 2, 2], 2, 4],
+      [:right, [1, 1, 2, 2], 3, 4],
+      [:right, [1, 2, 3], 0, 0],
+      [:right, [1, 2, 3], 1, 1],
+      [:right, [1, 2, 3], 1.5, 1],
+      [:right, [1, 2, 3], 2, 2],
+      [:right, [1, 2, 3], 2.5, 2],
+      [:right, [1, 2, 3], 3, 3],
+      [:right, [1, 2, 3], 4, 3],
+      [:right, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 0, 0],
+      [:right, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 1, 1],
+      [:right, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 1.5, 1],
+      [:right, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 2, 3],
+      [:right, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 2.5, 3],
+      [:right, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 3, 6],
+      [:right, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 3.5, 6],
+      [:right, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 4, 10],
+      [:right, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 5, 10],
+
+      [:left, [], 1, 0],
+      [:left, [1], 0, 0],
+      [:left, [1], 1, 0],
+      [:left, [1], 2, 1],
+      [:left, [1, 1], 0, 0],
+      [:left, [1, 1], 1, 0],
+      [:left, [1, 1], 2, 2],
+      [:left, [1, 1, 1], 0, 0],
+      [:left, [1, 1, 1], 1, 0],
+      [:left, [1, 1, 1], 2, 3],
+      [:left, [1, 1, 1, 1], 0, 0],
+      [:left, [1, 1, 1, 1], 1, 0],
+      [:left, [1, 1, 1, 1], 2, 4],
+      [:left, [1, 2], 0, 0],
+      [:left, [1, 2], 1, 0],
+      [:left, [1, 2], 1.5, 1],
+      [:left, [1, 2], 2, 1],
+      [:left, [1, 2], 3, 2],
+      [:left, [1, 1, 2, 2], 0, 0],
+      [:left, [1, 1, 2, 2], 1, 0],
+      [:left, [1, 1, 2, 2], 1.5, 2],
+      [:left, [1, 1, 2, 2], 2, 2],
+      [:left, [1, 1, 2, 2], 3, 4],
+      [:left, [1, 2, 3], 0, 0],
+      [:left, [1, 2, 3], 1, 0],
+      [:left, [1, 2, 3], 1.5, 1],
+      [:left, [1, 2, 3], 2, 1],
+      [:left, [1, 2, 3], 2.5, 2],
+      [:left, [1, 2, 3], 3, 2],
+      [:left, [1, 2, 3], 4, 3],
+      [:left, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 0, 0],
+      [:left, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 1, 0],
+      [:left, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 1.5, 1],
+      [:left, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 2, 1],
+      [:left, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 2.5, 3],
+      [:left, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 3, 3],
+      [:left, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 3.5, 6],
+      [:left, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 4, 6],
+      [:left, [1, 2, 2, 3, 3, 3, 4, 4, 4, 4], 5, 10]
+    ]
+  end
+
+  it "should bisect like the Python one" do
+
+    @test_cases.each do |direction, array, element, result|
+      case direction
+      when :left
+        Bisect.bisect_left(array, element).should == result
+      when :right
+        Bisect.bisect_right(array, element).should == result
+      else
+        raise "wtf?!"
+      end
+    end
+
+  end
+
+  it "should insort like the Python one" do
+    array = []
+    500.times do
+      digit = rand(10)
+      if digit % 2 == 0
+        Bisect.insort_left(array, digit)
+      else
+        Bisect.insort_right(array, digit)
+      end
+      array.should == array.sort
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: bisect
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Conrad Irwin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: A direct port of python's 'bisect' standard library to ruby.
+email:
+- conrad.irwin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- LICENSE.MIT
+- README.md
+- bisect.gemspec
+- lib/bisect.rb
+- lib/bisect/core_ext.rb
+- spec/bisect_spec.rb
+homepage: http://github.com/ConradIrwin/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: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Library for maintaining sorted arrays
+test_files: []
+has_rdoc: