hamster 1.0.1.pre.rc2 → 1.0.1.pre.rc3

data/lib/hamster/trie.rb

@@ -1,8 +1,9 @@
 module Hamster
+  # @private
   class Trie
     def self.[](pairs)
       result = self.new(0)
-      pairs.each { |key, val| result.send(:put!, key, val) }
+      pairs.each { |key, val| result.put!(key, val) }
       result
     end
 
@@ -27,21 +28,29 @@ module Hamster
     end
 
     # Calls <tt>block</tt> once for each entry in the trie, passing the key-value pair as parameters.
-    def each
+    def each(&block)
       @entries.each { |entry| yield(entry) if entry }
       @children.each do |child|
-        child.each { |entry| yield(entry) } if child
+        child.each(&block) if child
       end
       nil
     end
 
+    def reverse_each(&block)
+      @children.reverse_each do |child|
+        child.reverse_each(&block) if child
+      end
+      @entries.reverse_each { |entry| yield(entry) if entry }
+      nil
+    end
+
     def reduce(memo)
       each { |entry| memo = yield(memo, entry) }
       memo
     end
 
     def filter
-      reduce(self) { |trie, entry| yield(entry) ? trie : trie.delete(entry.key) }
+      reduce(self) { |trie, entry| yield(entry) ? trie : trie.delete(entry[0]) }
     end
 
     # Returns a copy of <tt>self</tt> with the given value associated with the key.
@@ -51,13 +60,13 @@ module Hamster
 
       if !entry
         entries = @entries.dup
-        key = key.dup.freeze if key.is_a?(String)
-        entries[index] = Entry.new(key, value)
+        key = key.dup.freeze if key.is_a?(String) && !key.frozen?
+        entries[index] = [key, value].freeze
         Trie.new(@significant_bits, @size + 1, entries, @children)
-      elsif entry.key.eql?(key)
+      elsif entry[0].eql?(key)
         entries = @entries.dup
-        key = key.dup.freeze if key.is_a?(String)
-        entries[index] = Entry.new(key, value)
+        key = key.dup.freeze if key.is_a?(String) && !key.frozen?
+        entries[index] = [key, value].freeze
         Trie.new(@significant_bits, @size, entries, @children)
       else
         children = @children.dup
@@ -74,11 +83,36 @@ module Hamster
       end
     end
 
+    # Returns <tt>self</tt> after overwriting the element associated with the specified key.
+    def put!(key, value)
+      index = index_for(key)
+      entry = @entries[index]
+      if !entry
+        @size += 1
+        key = key.dup.freeze if key.is_a?(String) && !key.frozen?
+        @entries[index] = [key, value].freeze
+      elsif entry[0].eql?(key)
+        key = key.dup.freeze if key.is_a?(String) && !key.frozen?
+        @entries[index] = [key, value].freeze
+      else
+        child = @children[index]
+        if child
+          old_child_size = child.size
+          @children[index] = child.put!(key, value)
+          @size += child.size - old_child_size
+        else
+          @children[index] = Trie.new(@significant_bits + 5).put!(key, value)
+          @size += 1
+        end
+      end
+      self
+    end
+
     # Retrieves the entry corresponding to the given key. If not found, returns <tt>nil</tt>.
     def get(key)
       index = index_for(key)
       entry = @entries[index]
-      if entry && entry.key.eql?(key)
+      if entry && entry[0].eql?(key)
         entry
       else
         child = @children[index]
@@ -93,7 +127,26 @@ module Hamster
 
     def include?(key, value)
       entry = get(key)
-      entry && value.eql?(entry.value)
+      entry && value.eql?(entry[1])
+    end
+
+    def at(index)
+      @entries.each do |entry|
+        if entry
+          return entry if index == 0
+          index -= 1
+        end
+      end
+      @children.each do |child|
+        if child
+          if child.size >= index+1
+            return child.at(index)
+          else
+            index -= child.size
+          end
+        end
+      end
+      nil
     end
 
     # Returns <tt>true</tt> if . <tt>eql?</tt> is synonymous with <tt>==</tt>
@@ -101,7 +154,7 @@ module Hamster
       return true if equal?(other)
       return false unless instance_of?(other.class) && size == other.size
       each do |entry|
-        return false unless other.include?(entry.key, entry.value)
+        return false unless other.include?(entry[0], entry[1])
       end
       true
     end
@@ -109,38 +162,13 @@ module Hamster
 
     protected
 
-    # Returns <tt>self</tt> after overwriting the element associated with the specified key.
-    def put!(key, value)
-      index = index_for(key)
-      entry = @entries[index]
-      if !entry
-        @size += 1
-        key = key.dup.freeze if key.is_a?(String)
-        @entries[index] = Entry.new(key, value)
-      elsif entry.key.eql?(key)
-        key = key.dup.freeze if key.is_a?(String)
-        @entries[index] = Entry.new(key, value)
-      else
-        child = @children[index]
-        if child
-          old_child_size = child.size
-          @children[index] = child.put!(key, value)
-          @size += child.size - old_child_size
-        else
-          @children[index] = Trie.new(@significant_bits + 5).put!(key, value)
-          @size += 1
-        end
-      end
-      self
-    end
-
     # Returns a replacement instance after removing the specified key.
     # If not found, returns <tt>self</tt>.
     # If empty, returns <tt>nil</tt>.
     def find_and_delete(key)
       index = index_for(key)
       entry = @entries[index]
-      if entry && entry.key.eql?(key)
+      if entry && entry[0].eql?(key)
         return delete_at(index)
       else
         child = @children[index]
@@ -184,16 +212,8 @@ module Hamster
     def copy_size(copy)
       copy ? copy.size : 0
     end
-
-    class Entry
-      attr_reader :key, :value
-
-      def initialize(key, value)
-        @key = key
-        @value = value
-      end
-    end
   end
 
+  # @private
   EmptyTrie = Hamster::Trie.new(0)
 end

data/lib/hamster/undefined.rb

@@ -1,7 +1,5 @@
 module Hamster
+  # @private
   module Undefined
-    def self.erase(value)
-      value unless value.equal?(self)
-    end
   end
 end

data/lib/hamster/vector.rb

@@ -1,177 +1,1090 @@
 require "forwardable"
-require "hamster/undefined"
 require "hamster/immutable"
 require "hamster/enumerable"
 
 module Hamster
   def self.vector(*items)
-    Vector.new(items)
+    items.empty? ? EmptyVector : Vector.new(items.freeze)
   end
 
+  # A `Vector` is an ordered, integer-indexed collection of objects. Like `Array`,
+  # `Vector` indexing starts at 0. Also like `Array`, negative indexes count back
+  # from the end of the `Vector`.
+  #
+  # `Vector`'s interface is modeled after that of `Array`, minus all the methods
+  # which do destructive updates. Some methods which modify `Array`s destructively
+  # (like {#insert} or {#delete_at}) are included, but they return new `Vectors`
+  # and leave the existing one unchanged.
+  #
+  # = Creating New Vectors
+  #
+  #     Hamster.vector('a', 'b', 'c')
+  #     Hamster::Vector.new([:first, :second, :third])
+  #     Hamster::Vector[1, 2, 3, 4, 5]
+  #
+  # = Retrieving Items from Vectors
+  #
+  #     require 'hamster/vector'
+  #     vector = Hamster.vector(1, 2, 3, 4, 5)
+  #     vector[0]      # => 1
+  #     vector[-1]     # => 5
+  #     vector[0,3]    # => Hamster::Vector[1, 2, 3]
+  #     vector[1..-1]  # => Hamster::Vector[2, 3, 4, 5]
+  #     vector.first   # => 1
+  #     vector.last    # => 5
+  #
+  # = Creating Modified Vectors
+  #
+  #     vector.add(6)            # => Hamster::Vector[1, 2, 3, 4, 5, 6]
+  #     vector.insert(1, :a, :b) # => Hamster::Vector[1, :a, :b, 2, 3, 4, 5]
+  #     vector.delete_at(2)      # => Hamster::Vector[1, 2, 4, 5]
+  #     vector + [6, 7]          # => Hamster::Vector[1, 2, 3, 4, 5, 6, 7]
+  #
+  # Other `Array`-like methods like {#select}, {#map}, {#shuffle}, {#uniq}, {#reverse},
+  # {#rotate}, {#flatten}, {#sort}, {#sort_by}, {#take}, {#drop}, {#take_while},
+  # {#drop_while}, {#fill}, {#product}, and {#transpose} are also supported.
+  #
   class Vector
     extend Forwardable
     include Immutable
     include Enumerable
 
+    # @private
     BLOCK_SIZE = 32
+    # @private
     INDEX_MASK = BLOCK_SIZE - 1
+    # @private
     BITS_PER_LEVEL = 5
 
+    # Return the number of items in this `Vector`
+    # @return [Integer]
     attr_reader :size
     def_delegator :self, :size, :length
 
     class << self
-      alias :alloc :new
-
-      def new(items=[])
-        items.empty? ? empty : alloc(items)
-      end
-
+      # Create a new `Vector` populated with the given items.
+      # @return [Vector]
       def [](*items)
-        new(items)
+        new(items.freeze)
       end
 
+      # Return an empty `Vector`. If used on a subclass, returns an empty instance
+      # of that class.
+      #
+      # @return [Vector]
       def empty
-        @empty ||= self.alloc
+        @empty ||= self.new
+      end
+
+      # "Raw" allocation of a new `Vector`. Used internally to create a new
+      # instance quickly after building a modified trie.
+      #
+      # @return [Vector]
+      # @private
+      def alloc(root, size, levels)
+        obj = allocate
+        obj.instance_variable_set(:@root, root)
+        obj.instance_variable_set(:@size, size)
+        obj.instance_variable_set(:@levels, levels)
+        obj
       end
     end
 
-    def initialize(items=[])
-      @root   = items
-      @size   = items.size
-      @levels = 0
-      while @root.size > 32
-        @root = @root.each_slice(32).to_a
-        @levels += 1
+    def initialize(items=[].freeze)
+      items = items.to_a
+      if items.size <= 32
+        items = items.dup.freeze if !items.frozen?
+        @root, @size, @levels = items, items.size, 0
+      else
+        root, size, levels = items, items.size, 0
+        while root.size > 32
+          root = root.each_slice(32).to_a
+          levels += 1
+        end
+        @root, @size, @levels = root.freeze, size, levels
       end
     end
 
+    # Return `true` if this `Vector` contains no items.
+    #
+    # @return [Boolean]
     def empty?
       @size == 0
     end
     def_delegator :self, :empty?, :null?
 
+    # Return the first item in the `Vector`. If the vector is empty, return `nil`.
+    #
+    # @return [Object]
     def first
       get(0)
     end
     def_delegator :self, :first, :head
 
+    # Return the last item in the `Vector`. If the vector is empty, return `nil`.
+    #
+    # @return [Object]
     def last
       get(-1)
     end
 
+    # Return a new `Vector` with `item` added after the last occupied position.
+    #
+    # @param item [Object] The object to insert at the end of the vector
+    # @return [Vector]
     def add(item)
-      transform do
-        update_leaf_node(@size, item)
-        @size += 1
-      end
+      update_root(@size, item)
     end
     def_delegator :self, :add, :<<
-    def_delegator :self, :add, :cons
     def_delegator :self, :add, :conj
     def_delegator :self, :add, :conjoin
+    def_delegator :self, :add, :push
 
-    # def delete(index)
-    # end
-
-    def set(index, item = Undefined)
-      return set(index, yield(get(index))) if item.equal?(Undefined)
-      raise IndexError if empty? || index == @size
-      raise IndexError if index.abs > @size
-      return set(@size + index, item) if index < 0
-      transform do
-        update_leaf_node(index, item)
-      end
+    # Return a new `Vector` with the item at `index` replaced by `item`. If the
+    # `item` argument is missing, but an optional code block is provided, it will
+    # be passed the existing item and what the block returns will replace it.
+    #
+    # @param index [Integer] The index to update
+    # @param item [Object] The object to insert into that position
+    # @return [Vector]
+    def set(index, item = yield(get(index)))
+      raise IndexError if @size == 0
+      index += @size if index < 0
+      raise IndexError if index > @size || index < 0
+      update_root(index, item)
     end
 
+    # Retrieve the item at `index`. If there is none (either the provided index
+    # is too high or too low), return `nil`.
+    #
+    # @param index [Integer] The index to retrieve
+    # @return [Object]
     def get(index)
-      return nil if empty? || index == @size
-      return nil if index.abs > @size
-      return get(@size + index) if index < 0
-      leaf_node_for(@root, root_index_bits, index)[index & INDEX_MASK]
+      return nil if @size == 0
+      index += @size if index < 0
+      return nil if index >= @size || index < 0
+      leaf_node_for(@root, @levels * BITS_PER_LEVEL, index)[index & INDEX_MASK]
     end
-    def_delegator :self, :get, :[]
     def_delegator :self, :get, :at
 
+    # Retrieve the value at `index`, or use the provided default value or block,
+    # or otherwise raise an `IndexError`.
+    #
+    # @overload fetch(index)
+    #   Retrieve the value at the given index, or raise an `IndexError` if it is
+    #   not found.
+    #   @param index [Integer] The index to look up
+    # @overload fetch(index) { |index| ... }
+    #   Retrieve the value at the given index, or call the optional
+    #   code block (with the non-existent index) and get its return value.
+    #   @yield [index] The index which does not exist
+    #   @yieldreturn [Object] Object to return instead
+    #   @param index [Integer] The index to look up
+    # @overload fetch(index, default)
+    #   Retrieve the value at the given index, or else return the provided
+    #   `default` value.
+    #   @param index [Integer] The index to look up
+    #   @param default [Object] Object to return if the key is not found
+    #
+    # @return [Object]
+    def fetch(index, default = (missing_default = true))
+      if index >= -@size && index < @size
+        get(index)
+      elsif block_given?
+        yield(index)
+      elsif !missing_default
+        default
+      else
+        raise IndexError, "index #{index} outside of vector bounds"
+      end
+    end
+
+    # Element reference. Return the item at a specific index, or a specified,
+    # contiguous range of items (as a new `Vector`).
+    #
+    # @overload vector[index]
+    #   Return the item at `index`.
+    #   @param index [Integer] The index to retrieve.
+    # @overload vector[start, length]
+    #   Return a subvector starting at index `start` and continuing for `length` elements.
+    #   @param start [Integer] The index to start retrieving items from.
+    #   @param length [Integer] The number of items to retrieve.
+    # @overload vector[range]
+    #   Return a subvector specified by the given `range` of indices.
+    #   @param range [Range] The range of indices to retrieve.
+    #
+    # @return [Object]
+    def [](arg, length = (missing_length = true))
+      if missing_length
+        if arg.is_a?(Range)
+          from, to = arg.begin, arg.end
+          from += @size if from < 0
+          to   += @size if to < 0
+          to   += 1     if !arg.exclude_end?
+          length = to - from
+          length = 0 if length < 0
+          subsequence(from, length)
+        else
+          get(arg)
+        end
+      else
+        arg += @size if arg < 0
+        subsequence(arg, length)
+      end
+    end
+    def_delegator :self, :[], :slice
+
+    # Return a new `Vector` with the given values inserted before the element at `index`.
+    #
+    # @param index [Integer] The index where the new items should go
+    # @param items [Array] The items to add
+    # @return [Vector]
+    def insert(index, *items)
+      raise IndexError if index < -@size
+      index += @size if index < 0
+
+      if index < @size
+        suffix = flatten_suffix(@root, @levels * BITS_PER_LEVEL, index, [])
+        suffix.unshift(*items)
+      elsif index == @size
+        suffix = items
+      else
+        suffix = Array.new(index - @size, nil).concat(items)
+        index = @size
+      end
+
+      replace_suffix(index, suffix)
+    end
+
+    # Return a new `Vector` with the element at `index` removed. If the given `index`
+    # does not exist, return `self`.
+    #
+    # @param index [Integer] The index to remove
+    # @return [Vector]
+    def delete_at(index)
+      return self if index >= @size || index < -@size
+      index += @size if index < 0
+
+      suffix = flatten_suffix(@root, @levels * BITS_PER_LEVEL, index, [])
+      replace_suffix(index, suffix.tap { |a| a.shift })
+    end
+
+    # Return a new `Vector` with the last element removed. If empty, just return `self`.
+    # @return [Vector]
+    def pop
+      return self if @size == 0
+      replace_suffix(@size-1, [])
+    end
+
+    # Return a new `Vector` with `obj` inserted before the first element, moving
+    # the other elements upwards.
+    # @param obj [Object] The value to prepend
+    # @return [Vector]
+    def unshift(obj)
+      insert(0, obj)
+    end
+
+    # Return a new `Vector` with the first element removed. If empty, just return `self`.
+    # @return [Vector]
+    def shift
+      delete_at(0)
+    end
+
+    # Call the given block once for each item in the vector, passing each
+    # item from first to last successively to the block.
+    #
+    # @return [self]
     def each(&block)
-      return self unless block_given?
-      traverse_depth_first(&block)
-      nil
+      return to_enum unless block_given?
+      traverse_depth_first(@root, @levels, &block)
+      self
     end
 
-    def map(&block)
-      return self unless block_given?
-      reduce(self.class.empty) { |vector, item| vector.add(yield(item)) }
+    # Call the given block once for each item in the vector, passing each
+    # item starting from the last, and counting back to the first, successively to
+    # the block.
+    #
+    # @return [self]
+    def reverse_each(&block)
+      return enum_for(:reverse_each) unless block_given?
+      reverse_traverse_depth_first(@root, @levels, &block)
+      self
     end
-    def_delegator :self, :map, :collect
 
+    # Return a new `Vector` containing all elements for which the given block returns
+    # true.
+    #
+    # @return [Vector]
     def filter
-      return self unless block_given?
+      return enum_for(:filter) unless block_given?
       reduce(self.class.empty) { |vector, item| yield(item) ? vector.add(item) : vector }
     end
 
+    # Return a new `Vector` with all items which are equal to `obj` removed.
+    # `#==` is used for checking equality.
+    #
+    # @param obj [Object] The object to remove (every occurrence)
+    # @return [Vector]
+    def delete(obj)
+      filter { |item| item != obj }
+    end
+
+    # Invoke the given block once for each item in the vector, and return a new
+    # `Vector` containing the values returned by the block.
+    #
+    # @return [Vector]
+    def map
+      return enum_for(:map) if not block_given?
+      return self if empty?
+      self.class.new(super)
+    end
+    def_delegator :self, :map, :collect
+
+    # Return a new `Vector` with the same elements as this one, but randomly permuted.
+    #
+    # @return [Vector]
+    def shuffle
+      self.class.new(((array = to_a).frozen? ? array.shuffle : array.shuffle!).freeze)
+    end
+
+    # Return a new `Vector` with no duplicate elements, as determined by `#hash` and
+    # `#eql?`. For each group of equivalent elements, only the first will be retained.
+    #
+    # @return [Vector]
+    def uniq
+      self.class.new(((array = to_a).frozen? ? array.uniq : array.uniq!).freeze)
+    end
+
+    # Return a new `Vector` with the same elements as this one, but in reverse order.
+    #
+    # @return [Vector]
+    def reverse
+      self.class.new(((array = to_a).frozen? ? array.reverse : array.reverse!).freeze)
+    end
+
+    # Return a new `Vector` with the same elements, but rotated so that the one at
+    # index `count` is the first element of the new vector. If `count` is positive,
+    # the elements will be shifted left, and those shifted past the lowest position
+    # will be moved to the end. If `count` is negative, the elements will be shifted
+    # right, and those shifted past the last position will be moved to the beginning.
+    #
+    # @param count [Integer] The number of positions to shift items by
+    # @return [Vector]
+    def rotate(count = 1)
+      return self if (count % @size) == 0
+      self.class.new(((array = to_a).frozen? ? array.rotate(count) : array.rotate!(count)).freeze)
+    end
+
+    # Return a new `Vector` with all nested vectors and arrays recursively "flattened
+    # out", that is, their elements inserted into the new `Vector` in the place where
+    # the nested array/vector originally was. If an optional `level` argument is
+    # provided, the flattening will only be done recursively that number of times.
+    # A `level` of 0 means not to flatten at all, 1 means to only flatten nested
+    # arrays/vectors which are directly contained within this `Vector`.
+    #
+    # @param level [Integer] The depth to which flattening should be applied
+    # @return [Vector]
+    def flatten(level = nil)
+      return self if level == 0
+      self.class.new(((array = to_a).frozen? ? array.flatten(level) : array.flatten!(level)).freeze)
+    end
+
+    # Return a new `Vector` built by concatenating this one with `other`. `other`
+    # can be any object which is convertible to an `Array` using `#to_a`.
+    #
+    # @param other [Enumerable] The collection to concatenate onto this vector
+    # @return [Vector]
+    def +(other)
+      other = other.to_a
+      other = other.dup if other.frozen?
+      replace_suffix(@size, other)
+    end
+    def_delegator :self, :+, :concat
+
+    # `others` should be arrays and/or vectors. The corresponding elements from this
+    # `Vector` and each of `others` (that is, the elements with the same indices)
+    # will be gathered into arrays.
+    #
+    # If an optional block is provided, each such array will be passed successively
+    # to the block. Otherwise, a new `Vector` of all those arrays will be returned.
+    #
+    # @param others [Array] The arrays/vectors to zip together with this one
+    # @return [Vector, nil]
+    def zip(*others)
+      if block_given?
+        super
+      else
+        self.class.new(super)
+      end
+    end
+
+    # Return a new `Vector` with the same items, but sorted. The sort order will
+    # be determined by comparing items using `#<=>`, or if an optional code block
+    # is provided, by using it as a comparator. The block should accept 2 parameters,
+    # and should return 0, 1, or -1 if the first parameter is equal to, greater than,
+    # or less than the second parameter (respectively).
+    #
+    # @return [Vector]
+    def sort
+      self.class.new(super)
+    end
+
+    # Return a new `Vector` with the same items, but sorted. The sort order will be
+    # determined by mapping the items through the given block to obtain sort keys,
+    # and then sorting the keys according to their natural sort order.
+    #
+    # @return [Vector]
+    def sort_by
+      self.class.new(super)
+    end
+
+    # Drop the first `n` elements and return the rest in a new `Vector`.
+    # @param n [Integer] The number of elements to remove
+    # @return [Vector]
+    def drop(n)
+      self.class.new(super)
+    end
+
+    # Return only the first `n` elements in a new `Vector`.
+    # @param n [Integer] The number of elements to retain
+    # @return [Vector]
+    def take(n)
+      self.class.new(super)
+    end
+
+    # Drop elements up to, but not including, the first element for which the
+    # block returns `nil` or `false`. Gather the remaining elements into a new
+    # `Vector`. If no block is given, an `Enumerator` is returned instead.
+    #
+    # @return [Vector, Enumerator]
+    def drop_while
+      return enum_for(:drop_while) if not block_given?
+      self.class.new(super)
+    end
+
+    # Gather elements up to, but not including, the first element for which the
+    # block returns `nil` or `false`, and return them in a new `Vector`. If no block
+    # is given, an `Enumerator` is returned instead.
+    #
+    # @return [Vector, Enumerator]
+    def take_while
+      return enum_for(:take_while) if not block_given?
+      self.class.new(super)
+    end
+
+    # Repetition. Return a new `Vector` built by concatenating `times` copies
+    # of this one together.
+    #
+    # @param times [Integer] The number of times to repeat the elements in this vector
+    # @return [Vector]
+    def *(times)
+      return self.class.empty if times == 0
+      return self if times == 1
+      result = (to_a * times)
+      result.is_a?(Array) ? self.class.new(result) : result
+    end
+
+    # Replace a range of indexes with the given object.
+    #
+    # @overload fill(obj)
+    #   Return a new `Vector` of the same size, with every index set to `obj`.
+    # @overload fill(obj, start)
+    #   Return a new `Vector` with all indexes from `start` to the end of the
+    #   vector set to `obj`.
+    # @overload fill(obj, start, length)
+    #   Return a new `Vector` with `length` indexes, beginning from `start`,
+    #   set to `obj`.
+    #
+    # @return [Vector]
+    def fill(obj, index = 0, length = nil)
+      raise IndexError if index < -@size
+      index += @size if index < 0
+      length ||= @size - index # to the end of the array, if no length given
+
+      if index < @size
+        suffix = flatten_suffix(@root, @levels * BITS_PER_LEVEL, index, [])
+        suffix.fill(obj, 0, length)
+      elsif index == @size
+        suffix = Array.new(length, obj)
+      else
+        suffix = Array.new(index - @size, nil).concat(Array.new(length, obj))
+        index = @size
+      end
+
+      replace_suffix(index, suffix)
+    end
+
+    # When invoked with a block, yields all combinations of length `n` of items
+    # from the `Vector`, and then returns `self`. There is no guarantee about
+    # which order the combinations will be yielded in.
+    #
+    # If no block is given, an `Enumerator` is returned instead.
+    #
+    # @return [self, Enumerator]
+    def combination(n)
+      return enum_for(:combination, n) if not block_given?
+      return self if n < 0 || @size < n
+      if n == 0
+        yield []
+      elsif n == 1
+        each { |item| yield [item] }
+      elsif n == @size
+        yield self.to_a
+      else
+        combos = lambda do |result,index,remaining|
+          while @size - index > remaining
+            if remaining == 1
+              yield result.dup << get(index)
+            else
+              combos[result.dup << get(index), index+1, remaining-1]
+            end
+            index += 1
+          end
+          index.upto(@size-1) { |i| result << get(i) }
+          yield result
+        end
+        combos[[], 0, n]
+      end
+      self
+    end
+
+    # When invoked with a block, yields all repeated combinations of length `n` of
+    # items from the `Vector`, and then returns `self`. A "repeated combination" is
+    # one in which any item from the `Vector` can appear consecutively any number of
+    # times.
+    #
+    # There is no guarantee about which order the combinations will be yielded in.
+    #
+    # If no block is given, an `Enumerator` is returned instead.
+    #
+    # @return [self, Enumerator]
+    def repeated_combination(n)
+      return enum_for(:repeated_combination, n) if not block_given?
+      if n < 0
+        # yield nothing
+      elsif n == 0
+        yield []
+      elsif n == 1
+        each { |item| yield [item] }
+      elsif @size == 0
+        # yield nothing
+      else
+        combos = lambda do |result,index,remaining|
+          while index < @size-1
+            if remaining == 1
+              yield result.dup << get(index)
+            else
+              combos[result.dup << get(index), index, remaining-1]
+            end
+            index += 1
+          end
+          item = get(index)
+          remaining.times { result << item }
+          yield result
+        end
+        combos[[], 0, n]
+      end
+      self
+    end
+
+    # Yields all permutations of length `n` of items from the `Vector`, and then
+    # returns `self`. If no length `n` is specified, permutations of all elements
+    # will be yielded.
+    #
+    # There is no guarantee about which order the permutations will be yielded in.
+    #
+    # If no block is given, an `Enumerator` is returned instead.
+    #
+    # @return [self, Enumerator]
+    def permutation(n = @size)
+      return enum_for(:permutation, n) if not block_given?
+      if n < 0 || @size < n
+        # yield nothing
+      elsif n == 0
+        yield []
+      elsif n == 1
+        each { |item| yield [item] }
+      else
+        used, result = [], []
+        perms = lambda do |index|
+          0.upto(@size-1) do |i|
+            if !used[i]
+              result[index] = get(i)
+              if index < n-1
+                used[i] = true
+                perms[index+1]
+                used[i] = false
+              else
+                yield result.dup
+              end
+            end
+          end
+        end
+        perms[0]
+      end
+      self
+    end
+
+    # When invoked with a block, yields all repeated permutations of length `n` of
+    # items from the `Vector`, and then returns `self`. A "repeated permutation" is
+    # one where any item from the `Vector` can appear any number of times, and in
+    # any position (not just consecutively)
+    #
+    # If no length `n` is specified, permutations of all elements will be yielded.
+    # There is no guarantee about which order the permutations will be yielded in.
+    #
+    # If no block is given, an `Enumerator` is returned instead.
+    #
+    # @return [self, Enumerator]
+    def repeated_permutation(n = @size)
+      return enum_for(:repeated_permutation, n) if not block_given?
+      if n < 0
+        # yield nothing
+      elsif n == 0
+        yield []
+      elsif n == 1
+        each { |item| yield [item] }
+      else
+        result = []
+        perms = lambda do |index|
+          0.upto(@size-1) do |i|
+            result[index] = get(i)
+            if index < n-1
+              perms[index+1]
+            else
+              yield result.dup
+            end
+          end
+        end
+        perms[0]
+      end
+      self
+    end
+
+    # With one or more vector or array arguments, return the cartesian product of
+    # this vector's elements and those of each argument; with no arguments, return the
+    # result of multiplying all this vector's items together.
+    #
+    # @overload product(*vectors)
+    #   Return a `Vector` of all combinations of elements from this `Vector` and each
+    #   of the given vectors or arrays. The length of the returned `Vector` is the product
+    #   of `self.size` and the size of each argument vector or array.
+    # @overload product
+    #   Return the result of multiplying all the items in this `Vector` together.
+    #
+    # @return [Vector]
+    def product(*vectors)
+      # if no vectors passed, return "product" as in result of multiplying all items
+      return super if vectors.empty?
+
+      vectors.unshift(self)
+
+      if vectors.any?(&:empty?)
+        return block_given? ? self : []
+      end
+
+      counters = Array.new(vectors.size, 0)
+
+      bump_counters = lambda do
+        i = vectors.size-1
+        counters[i] += 1
+        while counters[i] == vectors[i].size
+          counters[i] = 0
+          i -= 1
+          return true if i == -1 # we are done
+          counters[i] += 1
+        end
+        false # not done yet
+      end
+      build_array = lambda do
+        array = []
+        counters.each_with_index { |index,i| array << vectors[i][index] }
+        array
+      end
+
+      if block_given?
+        while true
+          yield build_array[]
+          return self if bump_counters[]
+        end
+      else
+        result = []
+        while true
+          result << build_array[]
+          return result if bump_counters[]
+        end
+      end
+    end
+
+    # Assume all elements are vectors or arrays and transpose the rows and columns.
+    # In other words, take the first element of each nested vector/array and gather
+    # them together into a new `Vector`. Do likewise for the second, third, and so on
+    # down to the end of each nested vector/array. Gather all the resulting `Vectors`
+    # into a new `Vector` and return it.
+    #
+    # This operation is closely related to {#zip}. The result is almost the same as
+    # calling {#zip} on the first nested vector/array with the others supplied as
+    # arguments.
+    #
+    # @return [Vector]
+    def transpose
+      return self.class.empty if empty?
+      result = Array.new(first.size) { [] }
+
+      0.upto(@size-1) do |i|
+        source = get(i)
+        if source.size != result.size
+          raise IndexError, "element size differs (#{source.size} should be #{result.size})"
+        end
+
+        0.upto(result.size-1) do |j|
+          result[j].push(source[j])
+        end
+      end
+
+      result.map! { |a| self.class.new(a) }
+      self.class.new(result)
+    end
+
+    # By using binary search, finds a value from this `Vector` which meets the
+    # condition defined by the provided block. Behavior is just like `Array#bsearch`.
+    # See `Array#bsearch` for details.
+    #
+    # @return [Object]
+    def bsearch
+      low, high, result = 0, @size, nil
+      while low < high
+        mid = (low + ((high - low) >> 1))
+        val = get(mid)
+        v   = yield val
+        if v.is_a? Numeric
+          if v == 0
+            return val
+          elsif v > 0
+            high = mid
+          else
+            low = mid + 1
+          end
+        elsif v == true
+          result = val
+          high = mid
+        elsif !v
+          low = mid + 1
+        else
+          raise TypeError, "wrong argument type #{v.class} (must be numeric, true, false, or nil)"
+        end
+      end
+      result
+    end
+
+    # Return an empty `Vector` instance, of the same class as this one. Useful if you
+    # have multiple subclasses of `Vector` and want to treat them polymorphically.
+    #
+    # @return [Vector]
     def clear
-      EmptyVector
+      self.class.empty
+    end
+
+    # Return a randomly chosen item from this `Vector`. If the vector is empty, return `nil`.
+    #
+    # @return [Object]
+    def sample
+      get(rand(@size))
+    end
+
+    # Return a new `Vector` with only the elements at the given `indices`, in the
+    # order specified by `indices`. If any of the `indices` do not exist, `nil`s will
+    # appear in their places.
+    #
+    # @param indices [Array] The indices to retrieve and gather into a new `Vector`
+    # @return [Vector]
+    def values_at(*indices)
+      self.class.new(indices.map { |i| get(i) }.freeze)
+    end
+
+    # Return the index of the last element which is equal to the provided object,
+    # or for which the provided block returns true.
+    #
+    # @overload rindex(obj)
+    #   Return the index of the last element in this `Vector` which is `#==` to `obj`.
+    # @overload rindex { |item| ... }
+    #   Return the index of the last element in this `Vector` for which the block
+    #   returns true. (Iteration starts from the last element, counts back, and
+    #   stops as soon as a matching element is found.)
+    #
+    # @return [Index]
+    def rindex(obj = (missing_arg = true))
+      i = @size - 1
+      if missing_arg
+        if block_given?
+          reverse_each { |item| return i if yield item; i -= 1 }
+          nil
+        else
+          enum_for(:rindex)
+        end
+      else
+        reverse_each { |item| return i if item == obj; i -= 1 }
+        nil
+      end
     end
 
-    def inspect
-      to_a.inspect
+    # Assumes all elements are nested, indexable collections, and searches through them,
+    # comparing `obj` with the first element of each nested collection. Return the
+    # first nested collection which matches, or `nil` if none is found.
+    #
+    # @param obj [Object] The object to search for
+    # @return [Object]
+    def assoc(obj)
+      each { |array| return array if obj == array[0] }
+      nil
     end
 
+    # Assumes all elements are nested, indexable collections, and searches through them,
+    # comparing `obj` with the second element of each nested collection. Return the
+    # first nested collection which matches, or `nil` if none is found.
+    #
+    # @param obj [Object] The object to search for
+    # @return [Object]
+    def rassoc(obj)
+      each { |array| return array if obj == array[1] }
+      nil
+    end
+
+    # Return an `Array` with the same elements, in the same order. The returned
+    # `Array` may or may not be frozen.
+    #
+    # @return [Array]
+    def to_a
+      if @levels == 0
+        @root
+      else
+        flatten_node(@root, @levels * BITS_PER_LEVEL, [])
+      end
+    end
+
+    # Return true if `other` has the same type and contents as this `Vector`.
+    #
+    # @param other [Object] The collection to compare with
+    # @return [Boolean]
     def eql?(other)
       return true if other.equal?(self)
       return false unless instance_of?(other.class) && @size == other.size
       @root.eql?(other.instance_variable_get(:@root))
     end
-    def_delegator :self, :eql?, :==
+
+    # See `Object#hash`.
+    # @return [Integer]
+    def hash
+      reduce(0) { |hash, item| (hash << 5) - hash + item.hash }
+    end
+
+    # @return [::Array]
+    # @private
+    def marshal_dump
+      to_a
+    end
+
+    # @private
+    def marshal_load(array)
+      initialize(array.freeze)
+    end
 
     private
 
-    def traverse_depth_first(node = @root, level = @levels, &block)
+    def traverse_depth_first(node, level, &block)
       return node.each(&block) if level == 0
       node.each { |child| traverse_depth_first(child, level - 1, &block) }
     end
 
-    def leaf_node_for(node, child_index_bits, index)
-      return node if child_index_bits == 0
-      child_index = (index >> child_index_bits) & INDEX_MASK
-      leaf_node_for(node[child_index], child_index_bits - BITS_PER_LEVEL, index)
+    def reverse_traverse_depth_first(node, level, &block)
+      return node.reverse_each(&block) if level == 0
+      node.reverse_each { |child| reverse_traverse_depth_first(child, level - 1, &block) }
+    end
+
+    def leaf_node_for(node, bitshift, index)
+      while bitshift > 0
+        node = node[(index >> bitshift) & INDEX_MASK]
+        bitshift -= BITS_PER_LEVEL
+      end
+      node
+    end
+
+    def update_root(index, item)
+      root, levels = @root, @levels
+      while index >= (1 << (BITS_PER_LEVEL * (levels + 1)))
+        root = [root].freeze
+        levels += 1
+      end
+      root = update_leaf_node(root, levels * BITS_PER_LEVEL, index, item)
+      self.class.alloc(root, @size > index ? @size : index + 1, levels)
+    end
+
+    def update_leaf_node(node, bitshift, index, item)
+      slot_index = (index >> bitshift) & INDEX_MASK
+      if bitshift > 0
+        old_child = node[slot_index] || []
+        item = update_leaf_node(old_child, bitshift - BITS_PER_LEVEL, index, item)
+      end
+      node.dup.tap { |n| n[slot_index] = item }.freeze
     end
 
-    def update_leaf_node(index, item)
-      copy_leaf_node_for(new_root, root_index_bits, index)[index & INDEX_MASK] = item
+    def flatten_range(node, bitshift, from, to)
+      from_slot = (from >> bitshift) & INDEX_MASK
+      to_slot   = (to   >> bitshift) & INDEX_MASK
+
+      if bitshift == 0 # are we at the bottom?
+        node.slice(from_slot, to_slot-from_slot+1)
+      elsif from_slot == to_slot
+        flatten_range(node[from_slot], bitshift - BITS_PER_LEVEL, from, to)
+      else
+        # the following bitmask can be used to pick out the part of the from/to indices
+        #   which will be used to direct path BELOW this node
+        mask   = ((1 << bitshift) - 1)
+        result = []
+
+        if from & mask == 0
+          flatten_node(node[from_slot], bitshift - BITS_PER_LEVEL, result)
+        else
+          result.concat(flatten_range(node[from_slot], bitshift - BITS_PER_LEVEL, from, from | mask))
+        end
+
+        (from_slot+1).upto(to_slot-1) do |slot_index|
+          flatten_node(node[slot_index], bitshift - BITS_PER_LEVEL, result)
+        end
+
+        if to & mask == mask
+          flatten_node(node[to_slot], bitshift - BITS_PER_LEVEL, result)
+        else
+          result.concat(flatten_range(node[to_slot], bitshift - BITS_PER_LEVEL, to & ~mask, to))
+        end
+
+        result
+      end
     end
 
-    def copy_leaf_node_for(node, child_index_bits, index)
-      return node if child_index_bits == 0
-      child_index = (index >> child_index_bits) & INDEX_MASK
-      child_node = node[child_index]
-      if child_node
-        child_node = child_node.dup
+    def flatten_node(node, bitshift, result)
+      if bitshift == 0
+        result.concat(node)
+      elsif bitshift == BITS_PER_LEVEL
+        node.each { |a| result.concat(a) }
       else
-        child_node = []
+        bitshift -= BITS_PER_LEVEL
+        node.each { |a| flatten_node(a, bitshift, result) }
       end
-      node[child_index] = child_node
-      copy_leaf_node_for(child_node, child_index_bits - BITS_PER_LEVEL, index)
+      result
     end
 
-    def new_root
-      if full?
-        @levels += 1
-        @root = [@root]
+    def subsequence(from, length)
+      return nil if from > @size || from < 0 || length < 0
+      length = @size - from if @size < from + length
+      return self.class.empty if length == 0
+      self.class.new(flatten_range(@root, @levels * BITS_PER_LEVEL, from, from + length - 1))
+    end
+
+    def flatten_suffix(node, bitshift, from, result)
+      from_slot = (from >> bitshift) & INDEX_MASK
+
+      if bitshift == 0
+        if from_slot == 0
+          result.concat(node)
+        else
+          result.concat(node.slice(from_slot, 32)) # entire suffix of node. excess length is ignored by #slice
+        end
       else
-        @root = @root.dup
+        mask = ((1 << bitshift) - 1)
+        if from & mask == 0
+          from_slot.upto(node.size-1) do |i|
+            flatten_node(node[i], bitshift - BITS_PER_LEVEL, result)
+          end
+        elsif child = node[from_slot]
+          flatten_suffix(child, bitshift - BITS_PER_LEVEL, from, result)
+          (from_slot+1).upto(node.size-1) do |i|
+            flatten_node(node[i], bitshift - BITS_PER_LEVEL, result)
+          end
+        end
+        result
       end
     end
 
-    def full?
-      (@size >> root_index_bits) > 31
+    def replace_suffix(from, suffix)
+      # new suffix can go directly after existing elements
+      raise IndexError if from > @size
+      root, levels = @root, @levels
+
+      if (from >> (BITS_PER_LEVEL * (@levels + 1))) != 0
+        # index where new suffix goes doesn't fall within current tree
+        # we will need to deepen tree
+        root = [root].freeze
+        levels += 1
+      end
+
+      new_size = from + suffix.size
+      root = replace_node_suffix(root, levels * BITS_PER_LEVEL, from, suffix)
+
+      if !suffix.empty?
+        levels.times { suffix = suffix.each_slice(32).to_a }
+        root.concat(suffix)
+        while root.size > 32
+          root = root.each_slice(32).to_a
+          levels += 1
+        end
+      else
+        while root.size == 1 && levels > 0
+          root = root[0]
+          levels -= 1
+        end
+      end
+
+      self.class.alloc(root.freeze, new_size, levels)
     end
 
-    def root_index_bits
-      @levels * BITS_PER_LEVEL
+    def replace_node_suffix(node, bitshift, from, suffix)
+      from_slot = (from >> bitshift) & INDEX_MASK
+
+      if bitshift == 0
+        if from_slot == 0
+          suffix.shift(32)
+        else
+          node.take(from_slot).concat(suffix.shift(32 - from_slot))
+        end
+      else
+        mask = ((1 << bitshift) - 1)
+        if from & mask == 0
+          if from_slot == 0
+            new_node = suffix.shift(32 * (1 << bitshift))
+            while bitshift != 0
+              new_node = new_node.each_slice(32).to_a
+              bitshift -= BITS_PER_LEVEL
+            end
+            new_node
+          else
+            result = node.take(from_slot)
+            remainder = suffix.shift((32 - from_slot) * (1 << bitshift))
+            while bitshift != 0
+              remainder = remainder.each_slice(32).to_a
+              bitshift -= BITS_PER_LEVEL
+            end
+            result.concat(remainder)
+          end
+        elsif child = node[from_slot]
+          result = node.take(from_slot)
+          result.push(replace_node_suffix(child, bitshift - BITS_PER_LEVEL, from, suffix))
+          remainder = suffix.shift((31 - from_slot) * (1 << bitshift))
+          while bitshift != 0
+            remainder = remainder.each_slice(32).to_a
+            bitshift -= BITS_PER_LEVEL
+          end
+          result.concat(remainder)
+        else
+          raise "Shouldn't happen"
+        end
+      end
     end
   end
 
-  EmptyVector = Hamster::Vector.new
+  # The canonical empty `Vector`. Returned by `Hamster.vector` and `Vector[]` when
+  # invoked with no arguments; also returned by `Vector.empty`. Prefer using this
+  # one rather than creating many empty vectors using `Vector.new`.
+  #
+  EmptyVector = Hamster::Vector.empty
 end