sorted_array_binary 0.0.2 → 0.0.3

data/README.md

@@ -31,8 +31,8 @@ array.push 'b', 'a' #=> ['a', 'b']
 array = SortedArrayBinary.new { |a, b| b <=> a }
 array.push 'a', 'b' #=> ['b', 'a']
 
-# Nils not allowed.
-array.push nil #=> ArgumentError is raised
+# Take care to only add items that can be compared with <=>.
+array.push nil, 1 #=> exception is raised
 ```
 
 ## Performance
@@ -41,5 +41,11 @@ When #push'ing 1000 random numbers into an array:
 ```
 sorted_array        (0.0.5)     1.179088
 array-sorted        (1.1.2)     0.076348
-sorted_array_binary (0.0.1)     0.015969
+sorted_array_binary (0.0.3)     0.005244
+```
+
+## Installation
+
+```
+gem install sorted_array_binary
 ```

data/lib/sorted_array_binary.rb

@@ -1,5 +1,7 @@
 # Copyright (C) 2014 by Dmitry Maksyoma <ledestin@gmail.com>
 
+require 'bsearch'
+
 # Automatically sorted array (by using binary search). Nils aren't allowed.
 # Methods that reorder elements are not implemented, as well as #[]= and #fill.
 #
@@ -14,37 +16,6 @@
 #   array = SortedArrayBinary.new { |a, b| b <=> a }
 #   array.push 'a', 'b' #=> ['b', 'a']
 class SortedArrayBinary < Array
-  # {{{2 ComparisonState
-  class ComparisonState #:nodoc:
-    def initialize state
-      raise ArgumentError, "invalid state: #{state.inspect}" \
-	unless state && state >= -1 && state <= 1
-
-      @state = state
-    end
-
-    def equal?
-      @state == 0
-    end
-
-    def greater?
-      @state == 1
-    end
-
-    def less?
-      @state == -1
-    end
-  end
-  # }}}2
-
-  class InvalidSortBlock < RuntimeError #:nodoc:
-  end
-
-  def self._check_for_nil *objs #:nodoc:
-    raise ArgumentError, "nils aren't allowed into sorted array" \
-      if objs.include?(nil)
-  end
-
   alias :old_insert :insert
   private :old_insert
   alias :old_sort! :sort!
@@ -63,7 +34,6 @@ class SortedArrayBinary < Array
     if args.size == 1
       # Passed initial array.
       if args.first.respond_to? :each
-	self.class._check_for_nil *args.first
 	super *args
 	old_sort!
 	return
@@ -72,14 +42,9 @@ class SortedArrayBinary < Array
       # Passed size and block.
       if block_given?
 	super *args, &b
-	self.class._check_for_nil *self
 	old_sort!
 	return
       end
-
-      # Passed size, but not obj, which means fill with nils.
-      raise ArgumentError, "can't fill array with nils" \
-	if args.first.is_a? Numeric
     end
 
     super
@@ -94,123 +59,54 @@ class SortedArrayBinary < Array
     raise NotImplementedError
   end
 
-  [:[]=, :fill, :insert, :reverse!, :rotate!, :shuffle!, :sort!, :unshift].
+  [:[]=, :fill, :insert, :reverse!, :rotate!, :shuffle!].
   each { |m|
     alias_method m, :_not_implemented
   }
 
-  # Same as Array#collect!, but:
-  # * Disallow nils in the resulting array.
-  # * The resulting array is sorted.
-  def collect! &b
+  def collect! &b #:nodoc:
     replace(collect &b)
   end
   alias :map! :collect!
 
-  # Same as Array#concat, but:
-  # * Disallow nils in the passed array.
-  # * The resulting array is sorted.
-  def concat other_ary
+  def concat other_ary #:nodoc:
     _add *other_ary
   end
 
-  # Same as Array#flatten!, but:
-  # * Disallow nils in the resulting array.
-  # * The resulting array is sorted.
-  def flatten! *args
+  def flatten! *args #:nodoc:
     replace(flatten *args)
   end
 
-  # Add objects to array, automatically placing them according to sort order.
-  # Disallow nils.
+  # Add objects to array, automatically placing them according to sort order
+  # (via <=> by default).
   def push *objs
     _add *objs
   end
   alias :<< :push
+  alias :unshift :push
 
-  # Same as Array#replace, but:
-  # * Disallow nils in @other_ary.
-  # * The resulting array is sorted.
-  def replace other_ary
-    self.class._check_for_nil *other_ary
+  def replace other_ary #:nodoc:
     super
     old_sort! &@sort_block
     self
   end
 
+  def sort! #:nodoc:
+  end
+
   #private
   # Name the following methods starting with underscore so as not to pollute
   # Array namespace. They are considered private, but for testing purposes are
   # left public.
 
   def _add *objs #:nodoc:
-    self.class._check_for_nil *objs
     objs.each { |obj|
       old_insert _find_insert_position(obj), obj
     }
     self
   end
 
-  def _check_can_calc_boundary? #:nodoc:
-    raise "can't calc boundary on empty array" if empty?
-  end
-
-  def _compare a, b #:nodoc:
-    ComparisonState.new(ret = @sort_block.call(a, b))
-  rescue ArgumentError
-    raise InvalidSortBlock,
-      "sort block returned invalid value: #{ret.inspect}"
-  end
-
   def _find_insert_position element_to_place #:nodoc:
-    return 0 if empty?
-
-    start_idx, end_idx = 0, size - 1
-    loop {
-      middle_idx = _middle_element_index(start_idx, end_idx)
-      middle_el = self[middle_idx]
-      after_middle_idx = middle_idx + 1
-
-      comparison_state = _compare(element_to_place, middle_el)
-
-      # 1. Equals to the middle element. Insert after el.
-      return after_middle_idx if comparison_state.equal?
-
-      # 2. Less than the middle element.
-      if comparison_state.less?
-	# There's nothing to the left. So insert it as the first element.
-	return 0 if _left_boundary? middle_idx
-
-	end_idx = middle_idx - 1
-	next
-      end
-
-      # 3. Greater than the middle element.
-      #
-      # Right boundary? Put element_to_place after the last (middle) element.
-      return after_middle_idx if _right_boundary? middle_idx
-
-      # Less than after middle element? Put it right before it!
-      after_middle_el = self[after_middle_idx]
-      ret = _compare(element_to_place, after_middle_el)
-      return after_middle_idx if ret.equal? || ret.less?
-
-      # Proceeed to divide the right part.
-      start_idx = after_middle_idx
-    }
-  end
-
-  def _left_boundary? idx #:nodoc:
-    _check_can_calc_boundary?
-    idx == 0
-  end
-
-  def _middle_element_index start, ending #:nodoc:
-    start + (ending - start)/2
-  end
-
-  def _right_boundary? idx #:nodoc:
-    _check_can_calc_boundary?
-    idx == size - 1
+    bsearch_upper_boundary { |el| @sort_block.call el, element_to_place }
   end
 end

data/perf-tests/profile

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby
+
+require '../lib/sorted_array_binary'
+
+@ar = []
+COUNT = 10000
+COUNT.times {
+  @ar << rand(COUNT)
+}
+
+sorted_array = SortedArrayBinary.new
+@ar.each { |el| sorted_array.push el }

data/sorted_array_binary.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'sorted_array_binary'
-  s.version     = '0.0.2'
-  s.date        = '2014-01-29'
+  s.version     = '0.0.3'
+  s.date        = '2014-01-31'
   s.summary     = 'Sorted array'
   s.description = 'Sorted array using binary search'
   s.authors     = ['Dmitry Maksyoma']
@@ -13,4 +13,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec', '>= 2.13'
   s.add_development_dependency 'hitimes', '~> 1.2'
+  s.add_runtime_dependency 'bsearch', '~> 1.5'
 end

data/spec/sorted_array_binary_spec.rb

@@ -12,21 +12,6 @@ describe SortedArrayBinary do
     @ar = SortedArrayBinary.new
   end
 
-  # {{{2 self._check_for_nil
-  context 'self._check_for_nil' do
-    it "raises exception if there's nil in passed objs" do
-      expect {
-	SortedArrayBinary._check_for_nil 'a', nil
-      }.to raise_error ArgumentError
-    end
-
-    it "doesn't raise exception if there's no nil in passed objs" do
-      expect {
-	SortedArrayBinary._check_for_nil 'a', 'b'
-      }.not_to raise_error
-    end
-  end
-
   # {{{2 self.new
   context 'self.new' do
     it 'if passed size and obj, fills it' do
@@ -34,23 +19,13 @@ describe SortedArrayBinary do
       @ar.should == ['a']*5
     end
 
-    it 'if passed just size, raises exception' do
-      expect { SortedArrayBinary.new 5 }.to raise_error ArgumentError
-    end
-
     it 'if passed single non-numeric argument, calls Array#new' do
       expect { SortedArrayBinary.new 'a' }.to raise_error TypeError
     end
 
-    context 'if passed array,' do
-      it 'sorts it' do
-	@ar = SortedArrayBinary.new ['b', 'a']
-	@ar.should == ['a', 'b']
-      end
-
-      it 'raises exception if nil found in passed array' do
-	expect { SortedArrayBinary.new [nil] }.to raise_error ArgumentError
-      end
+    it 'if passed array, it sorts it' do
+      @ar = SortedArrayBinary.new ['b', 'a']
+      @ar.should == ['a', 'b']
     end
 
     it 'if passed size and block, fills it and sorts it' do
@@ -75,7 +50,7 @@ describe SortedArrayBinary do
       expect { @ar.fill nil }.to raise_error NotImplementedError
     end
 
-    [:insert, :reverse!, :rotate!, :shuffle!, :sort!, :unshift].
+    [:insert, :reverse!, :rotate!, :shuffle!].
     each { |m|
       it "##{m}" do
 	expect { @ar.send m }.to raise_error NotImplementedError
@@ -104,12 +79,6 @@ describe SortedArrayBinary do
 	  end
 	end
       }
-
-      it 'raises exception if one of resulting elements is nil' do
-	@ar.push 'a'
-	expect { @ar.send(method) { nil } }.to raise_error ArgumentError
-	@ar.should == ['a']
-      end
     end
   }
 
@@ -143,16 +112,10 @@ describe SortedArrayBinary do
 	end
       end
     }
-
-    it 'raises exception if resulting array contains nil' do
-      @ar.push [nil, 1]
-      expect { @ar.flatten! }.to raise_error ArgumentError
-      @ar.should == [[nil, 1]]
-    end
   end
 
   # {{{2 #push
-  [:<<, :push].each { |method|
+  [:<<, :push, :unshift].each { |method|
     context "##{method}" do
       it 'adds an element to array' do
 	@ar.send method, 'a'
@@ -177,10 +140,6 @@ describe SortedArrayBinary do
 	@ar.push 'a', 'b'
 	@ar.should == ['d', 'c', 'b', 'a']
       end
-
-      it 'raises exception if nil is passed' do
-	expect { @ar.send method, nil }.to raise_error ArgumentError
-      end
     end
   }
 
@@ -198,52 +157,6 @@ describe SortedArrayBinary do
 	end
       end
     }
-
-    it "doesn't allow nils" do
-      expect { @ar.replace [nil] }.to raise_error ArgumentError
-    end
-  end
-
-  # {{{2 #_compare
-  context '#_compare' do
-    context 'sort block not given' do
-      it 'returns :equal if arguments are equal' do
-	@ar._compare(1, 1).equal?.should be_true
-      end
-
-      it 'returns :less if arg1 < arg2' do
-	@ar._compare(1, 2).less?.should be_true
-      end
-
-      it 'returns :greater if arg1 > arg2' do
-	@ar._compare(2, 1).greater?.should be_true
-      end
-    end
-
-    context 'sort block given' do
-      before :each do
-	@ar = SortedArrayBinary.new { |a, b| b <=> a }
-      end
-
-      it 'returns :equal if arguments are equal' do
-	@ar._compare(1, 1).equal?.should be_true
-      end
-
-      it 'returns :less if arg1 < arg2' do
-	@ar._compare(2, 1).less?.should be_true
-      end
-
-      it 'returns :greater if arg1 > arg2' do
-	@ar._compare(1, 2).greater?.should be_true
-      end
-
-      it 'raises exception if block returns value outside of -1, 0, 1' do
-	@ar = SortedArrayBinary.new { 'a' }
-	expect {
-	  @ar.push 1, 2
-	}.to raise_error SortedArrayBinary::InvalidSortBlock
-      end
-    end
   end
 
   # {{{2 #_find_insert_position
@@ -293,96 +206,5 @@ describe SortedArrayBinary do
       end
     end
   end
-
-  # {{{2 #_middle_element_index
-  context '_middle_element_index' do
-    it "returns first element index if there's one element" do
-      @ar._middle_element_index(0, 0).should == 0
-      @ar._middle_element_index(1, 1).should == 1
-    end
-
-    it 'returns 0 if there are 2 elements in the array' do
-      @ar._middle_element_index(0, 1).should == 0
-    end
-
-    it 'returns 1 if there are 3 elements in the array' do
-      @ar._middle_element_index(0, 2).should == 1
-    end
-
-    it 'returns 1 if there are 4 elements in the array' do
-      @ar._middle_element_index(0, 3).should == 1
-    end
-  end
-
-  # {{{2 #_left_boundary, #_right_boundary
-  context '#_left_boundary, #_right_boundary' do
-    context 'left' do
-      it "returns true if it's left boundary?" do
-	@ar.push 'a' 
-	@ar._left_boundary?(0).should == true
-      end
-
-      it "returns false if it's not left boundary?" do
-	@ar.push 'a' 
-	@ar._left_boundary?(1).should == false
-      end
-
-      it 'raises exception if array is empty' do
-	expect {
-	  @ar._left_boundary?(0)
-	}.to raise_error
-      end
-    end
-
-    context 'right' do
-      it "returns true if it's right boundary?" do
-	@ar.push 'a', 'b'
-	@ar._right_boundary?(1).should == true
-      end
-
-      it "returns false if it's not right boundary?" do
-	@ar.push 'a', 'b'
-	@ar._right_boundary?(0).should == false
-      end
-
-      it 'raises exception if array is empty' do
-	expect {
-	  @ar._right_boundary?(0)
-	}.to raise_error
-      end
-    end
-  end
   # }}}2
 end
-
-# {{{1 ComparisonState
-describe SortedArrayBinary::ComparisonState do
-  [nil, -2, 2].each { |state|
-    it "allows only valid state in" do
-      expect {
-	SortedArrayBinary::ComparisonState.new state
-      }.to raise_error ArgumentError
-    end
-  }
-
-  it 'is equal? if state is 0' do
-    state = SortedArrayBinary::ComparisonState.new 0
-    state.equal?.should be_true
-    state.less?.should be_false
-    state.greater?.should be_false
-  end
-
-  it 'is greater? if state is 1' do
-    state = SortedArrayBinary::ComparisonState.new 1
-    state.greater?.should be_true
-    state.equal?.should be_false
-    state.less?.should be_false
-  end
-
-  it 'is less? if state is -1' do
-    state = SortedArrayBinary::ComparisonState.new -1
-    state.less?.should be_true
-    state.equal?.should be_false
-    state.greater?.should be_false
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorted_array_binary
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bsearch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
 description: Sorted array using binary search
 email: ledestin@gmail.com
 executables: []
@@ -61,6 +77,7 @@ files:
 - perf-tests/common.rb
 - perf-tests/perf-vs-sort
 - perf-tests/perf-vs-sorted_array
+- perf-tests/profile
 - sorted_array_binary.gemspec
 - spec/sorted_array_binary_spec.rb
 - spec/spec_helper.rb