Class: Immutable::Vector

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/immutable/vector.rb

Overview

A ‘Vector` is an ordered, integer-indexed collection of objects. Like Ruby’s ‘Array`, `Vector` indexing starts at zero and negative indexes count back from the end.

‘Vector` has a similar interface to `Array`. The main difference is methods that would destructively update an `Array` (such as #insert or #delete_at) instead return new `Vectors` and leave the existing one unchanged.

### Creating New Vectors

Immutable::Vector.new([:first, :second, :third])
Immutable::Vector[1, 2, 3, 4, 5]

### Retrieving Items from Vectors

vector = Immutable::Vector[1, 2, 3, 4, 5]

vector[0]      # => 1
vector[-1]     # => 5
vector[0,3]    # => Immutable::Vector[1, 2, 3]
vector[1..-1]  # => Immutable::Vector[2, 3, 4, 5]
vector.first   # => 1
vector.last    # => 5

### Creating Modified Vectors

vector.add(6)            # => Immutable::Vector[1, 2, 3, 4, 5, 6]
vector.insert(1, :a, :b) # => Immutable::Vector[1, :a, :b, 2, 3, 4, 5]
vector.delete_at(2)      # => Immutable::Vector[1, 2, 4, 5]
vector + [6, 7]          # => Immutable::Vector[1, 2, 3, 4, 5, 6, 7]

Constant Summary collapse

BLOCK_SIZE = 
32
INDEX_MASK = 
BLOCK_SIZE - 1
BITS_PER_LEVEL = 
5

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

#<=>, #==, #compact, #each_index, #grep, #grep_v, #group_by, #inspect, #join, #partition, #pretty_print, #reject, #sum, #to_set

Methods included from Enumerable

#to_list

Constructor Details

#initialize(items = [].freeze) ⇒ Vector

Returns a new instance of Vector.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/immutable/vector.rb', line 82

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
  freeze
end

Instance Attribute Details

#size ⇒ Integer (readonly) Also known as: length

Return the number of items in this ‘Vector`

Returns:

  • (Integer) 


50
51
52
 
# File 'lib/immutable/vector.rb', line 50

def size
  @size
end

Class Method Details

.[](*items) ⇒ Vector

Create a new ‘Vector` populated with the given items.

Returns:



56
57
58
 
# File 'lib/immutable/vector.rb', line 56

def [](*items)
  new(items.freeze)
end

.alloc(root, size, levels) ⇒ Vector

“Raw” allocation of a new ‘Vector`. Used internally to create a new instance quickly after building a modified trie.

Returns:



73
74
75
76
77
78
79
 
# File 'lib/immutable/vector.rb', line 73

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.freeze
end

.empty ⇒ Vector

Return an empty ‘Vector`. If used on a subclass, returns an empty instance of that class.

Returns:



64
65
66
 
# File 'lib/immutable/vector.rb', line 64

def empty
  @empty ||= self.new
end

Instance Method Details

#*(times) ⇒ Vector

Repetition. Return a new ‘Vector` built by concatenating `times` copies of this one together.

Examples:

Immutable::Vector["A", "B"] * 3
# => Immutable::Vector["A", "B", "A", "B", "A", "B"]

Parameters:

  • times (Integer) —

    The number of times to repeat the elements in this vector

Returns:



778
779
780
781
782
783
 
# File 'lib/immutable/vector.rb', line 778

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

#+(other) ⇒ Vector Also known as: concat

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`.

Examples:

Immutable::Vector["A", "B", "C"] + ["D", "E"]
# => Immutable::Vector["A", "B", "C", "D", "E"]

Parameters:

  • other (Enumerable) —

    The collection to concatenate onto this vector

Returns:



631
632
633
634
635
 
# File 'lib/immutable/vector.rb', line 631

def +(other)
  other = other.to_a
  other = other.dup if other.frozen?
  replace_suffix(@size, other)
end

#add(item) ⇒ Vector Also known as: <<, push

Return a new ‘Vector` with `item` added after the last occupied position.

Examples:

Immutable::Vector[1, 2].add(99)  # => Immutable::Vector[1, 2, 99]

Parameters:

  • item (Object) —

    The object to insert at the end of the vector

Returns:



132
133
134
 
# File 'lib/immutable/vector.rb', line 132

def add(item)
  update_root(@size, item)
end

#assoc(obj) ⇒ Object

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. Behaviour is undefined when elements do not meet assumptions (i.e. are not indexable collections).

Examples:

v = Immutable::Vector[["A", 10], ["B", 20], ["C", 30]]
v.assoc("B")  # => ["B", 20]

Parameters:

  • obj (Object) —

    The object to search for

Returns:

  • (Object) 


1263
1264
1265
1266
1267
1268
1269
 
# File 'lib/immutable/vector.rb', line 1263

def assoc(obj)
  each do |array|
    next if !array.respond_to?(:[])
    return array if obj == array[0]
  end
  nil
end

#bsearch {|element| ... } ⇒ Object

Finds a value from this ‘Vector` which meets the condition defined by the provided block, using a binary search. The vector must already be sorted with respect to the block. See Ruby’s ‘Array#bsearch` for details, behaviour is equivalent.

Examples:

v = Immutable::Vector[1, 3, 5, 7, 9, 11, 13]
# Block returns true/false for exact element match:
v.bsearch { |e| e > 4 }      # => 5
# Block returns number to match an element in 4 <= e <= 7:
v.bsearch { |e| 1 - e / 4 }  # => 7

Yields:

  • Once for at most ‘log n` elements, where `n` is the size of the vector. The exact elements and ordering are undefined.

Yield Parameters:

  • element (Object) —

    element to be evaluated

Yield Returns:

  • (Boolean) —

    ‘true` if this element matches the criteria, `false` otherwise.

  • (Integer) —

    See ‘Array#bsearch` for details.

Returns:

  • (Object) —

    The matched element, or ‘nil` if none found.

Raises:

  • TypeError if the block returns a non-numeric, non-boolean, non-nil value.



1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
 
# File 'lib/immutable/vector.rb', line 1157

def bsearch
  return enum_for(:bsearch) if not block_given?
  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

#clear ⇒ Vector

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.

Returns:



1188
1189
1190
 
# File 'lib/immutable/vector.rb', line 1188

def clear
  self.class.empty
end

#combination(n) ⇒ self, Enumerator

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.

If no block is given, an ‘Enumerator` is returned instead.

Examples:

v = Immutable::Vector[5, 6, 7, 8]
v.combination(3) { |c| puts "Combination: #{c}" }

Combination: [5, 6, 7]
Combination: [5, 6, 8]
Combination: [5, 7, 8]
Combination: [6, 7, 8]
#=> Immutable::Vector[5, 6, 7, 8]

Returns:

  • (self, Enumerator) 


857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/immutable/vector.rb', line 857

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

#delete(obj) ⇒ Vector

Return a new ‘Vector` with all items which are equal to `obj` removed. `#==` is used for checking equality.

Examples:

Immutable::Vector["C", "B", "A", "B"].delete("B")  # => Immutable::Vector["C", "A"]

Parameters:

  • obj (Object) —

    The object to remove (every occurrence)

Returns:



504
505
506
 
# File 'lib/immutable/vector.rb', line 504

def delete(obj)
  select { |item| item != obj }
end

#delete_at(index) ⇒ Vector

Return a new ‘Vector` with the element at `index` removed. If the given `index` does not exist, return `self`.

Examples:

Immutable::Vector["A", "B", "C", "D"].delete_at(2)
# => Immutable::Vector["A", "B", "D"]

Parameters:

  • index (Integer) —

    The index to remove

Returns:



400
401
402
403
404
405
406
 
# File 'lib/immutable/vector.rb', line 400

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

#dig(key, *rest) ⇒ Object

Return the value of successively indexing into a nested collection. If any of the keys is not present, return ‘nil`.

Examples:

v = Immutable::Vector[9, Immutable::Hash[c: 'a', d: 4]]
v.dig(1, :c) # => "a"
v.dig(1, :f) # => nil

Returns:

  • (Object) 


291
292
293
294
295
296
297
298
 
# File 'lib/immutable/vector.rb', line 291

def dig(key, *rest)
  value = self[key]
  if rest.empty? || value.nil?
    value
  else
    value.dig(*rest)
  end
end

#drop(n) ⇒ Vector

Drop the first ‘n` elements and return the rest in a new `Vector`.

Examples:

Immutable::Vector["A", "B", "C", "D", "E", "F"].drop(2)
# => Immutable::Vector["C", "D", "E", "F"]

Parameters:

  • n (Integer) —

    The number of elements to remove

Returns:

Raises:

  • ArgumentError if ‘n` is negative.



721
722
723
724
725
726
 
# File 'lib/immutable/vector.rb', line 721

def drop(n)
  return self if n == 0
  return self.class.empty if n >= @size
  raise ArgumentError, "attempt to drop negative size" if n < 0
  self.class.new(flatten_suffix(@root, @levels * BITS_PER_LEVEL, n, []))
end

#drop_while ⇒ Vector, Enumerator

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.

Examples:

Immutable::Vector[1, 3, 5, 7, 6, 4, 2].drop_while { |e| e < 5 }
# => Immutable::Vector[5, 7, 6, 4, 2]

Returns:



750
751
752
753
 
# File 'lib/immutable/vector.rb', line 750

def drop_while
  return enum_for(:drop_while) if not block_given?
  self.class.new(super)
end

#dup ⇒ Vector Also known as: clone

Return ‘self`. Since this is an immutable object duplicates are equivalent.

Returns:



1325
1326
1327
 
# File 'lib/immutable/vector.rb', line 1325

def dup
  self
end

#each(&block) ⇒ self, Enumerator

Call the given block once for each item in the vector, passing each item from first to last successively to the block. If no block is given, an ‘Enumerator` is returned instead.

Examples:

Immutable::Vector["A", "B", "C"].each { |e| puts "Element: #{e}" }

Element: A
Element: B
Element: C
# => Immutable::Vector["A", "B", "C"]

Returns:

  • (self, Enumerator) 


457
458
459
460
461
 
# File 'lib/immutable/vector.rb', line 457

def each(&block)
  return to_enum unless block_given?
  traverse_depth_first(@root, @levels, &block)
  self
end

#empty? ⇒ Boolean

Return ‘true` if this `Vector` contains no items.

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/immutable/vector.rb', line 101

def empty?
  @size == 0
end

#eql?(other) ⇒ Boolean

Return true if ‘other` has the same type and contents as this `Vector`.

Parameters:

  • other (Object) —

    The collection to compare with

Returns:

  • (Boolean) 


1310
1311
1312
1313
1314
 
# File 'lib/immutable/vector.rb', line 1310

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

#fetch(index) ⇒ Object #fetch(index) {|index| ... } ⇒ Object #fetch(index, default) ⇒ Object

Retrieve the value at ‘index` with optional default.

Overloads:

  • #fetch(index) ⇒ Object

    Retrieve the value at the given index, or raise an ‘IndexError` if not found.

    Examples:

    v = Immutable::Vector["A", "B", "C", "D"]
v.fetch(2)       # => "C"
v.fetch(-1)      # => "D"
v.fetch(4)       # => IndexError: index 4 outside of vector bounds

    Parameters:

    • index (Integer) —

      The index to look up

    Raises:

    • (IndexError) —

      if index does not exist

  • #fetch(index) {|index| ... } ⇒ Object

    Retrieve the value at the given index, or return the result of yielding the block if not found.

    Examples:

    v = Immutable::Vector["A", "B", "C", "D"]
v.fetch(2) { |i| i * i }   # => "C"
v.fetch(4) { |i| i * i }   # => 16

    Parameters:

    • index (Integer) —

      The index to look up

    Yields:

    • Once if the index is not found.

    Yield Parameters:

    • index (Integer) —

      The index which does not exist

    Yield Returns:

    • (Object) —

      Default value to return

  • #fetch(index, default) ⇒ Object

    Retrieve the value at the given index, or return the provided ‘default` value if not found.

    Examples:

    v = Immutable::Vector["A", "B", "C", "D"]
v.fetch(2, "Z")  # => "C"
v.fetch(4, "Z")  # => "Z"

    Parameters:

    • index (Integer) —

      The index to look up

    • default (Object) —

      Object to return if the key is not found

Returns:

  • (Object) 


270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/immutable/vector.rb', line 270

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

#fill(object) ⇒ Vector #fill(object, index) ⇒ Vector #fill(object, index, length) ⇒ Vector

Replace a range of indexes with the given object.

Overloads:

  • #fill(object) ⇒ Vector

    Return a new ‘Vector` of the same size, with every index set to `object`.

    Examples:

    Immutable::Vector["A", "B", "C", "D", "E", "F"].fill("Z")
# => Immutable::Vector["Z", "Z", "Z", "Z", "Z", "Z"]

    Parameters:

    • object (Object) —

      Fill value.

  • #fill(object, index) ⇒ Vector

    Return a new ‘Vector` with all indexes from `index` to the end of the vector set to `object`.

    Examples:

    Immutable::Vector["A", "B", "C", "D", "E", "F"].fill("Z", 3)
# => Immutable::Vector["A", "B", "C", "Z", "Z", "Z"]

    Parameters:

    • object (Object) —

      Fill value.

    • index (Integer) —

      Starting index. May be negative.

  • #fill(object, index, length) ⇒ Vector

    Return a new ‘Vector` with `length` indexes, beginning from `index`, set to `object`. Expands the `Vector` if `length` would extend beyond the current length.

    Examples:

    Immutable::Vector["A", "B", "C", "D", "E", "F"].fill("Z", 3, 2)
# => Immutable::Vector["A", "B", "C", "Z", "Z", "F"]
Immutable::Vector["A", "B"].fill("Z", 1, 5)
# => Immutable::Vector["A", "Z", "Z", "Z", "Z", "Z"]

    Parameters:

    • object (Object) —

      Fill value.

    • index (Integer) —

      Starting index. May be negative.

    • length (Integer)

Returns:

Raises:

  • (IndexError) —

    if index is out of negative range.



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/immutable/vector.rb', line 822

def fill(object, 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(object, 0, length)
  elsif index == @size
    suffix = Array.new(length, object)
  else
    suffix = Array.new(index - @size, nil).concat(Array.new(length, object))
    index = @size
  end

  replace_suffix(index, suffix)
end

#first ⇒ Object

Return the first item in the ‘Vector`. If the vector is empty, return `nil`.

Examples:

Immutable::Vector["A", "B", "C"].first  # => "A"

Returns:

  • (Object) 


111
112
113
 
# File 'lib/immutable/vector.rb', line 111

def first
  get(0)
end

#flat_map ⇒ Vector

Return a new ‘Vector` with the concatenated results of running the block once for every element in this `Vector`.

Examples:

Immutable::Vector[1, 2, 3].flat_map { |x| [x, -x] }
# => Immutable::Vector[1, -1, 2, -2, 3, -3]

Returns:



531
532
533
534
535
 
# File 'lib/immutable/vector.rb', line 531

def flat_map
  return enum_for(:flat_map) if not block_given?
  return self if empty?
  self.class.new(super)
end

#flatten(level = -1)) ⇒ Vector

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`.

Examples:

v = Immutable::Vector["A", Immutable::Vector["B", "C", Immutable::Vector["D"]]]
v.flatten(1)
# => Immutable::Vector["A", "B", "C", Immutable::Vector["D"]]
v.flatten
# => Immutable::Vector["A", "B", "C", "D"]

Parameters:

  • level (Integer) (defaults to: -1)) —

    The depth to which flattening should be applied

Returns:



610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/immutable/vector.rb', line 610

def flatten(level = -1)
  return self if level == 0
  array = self.to_a
  if array.frozen?
    self.class.new(array.flatten(level).freeze)
  elsif array.flatten!(level) # returns nil if no changes were made
    self.class.new(array.freeze)
  else
    self
  end
end

#get(index) ⇒ Object Also known as: at

Retrieve the item at ‘index`. If there is none (either the provided index is too high or too low), return `nil`.

Examples:

v = Immutable::Vector["A", "B", "C", "D"]
v.get(2)   # => "C"
v.get(-1)  # => "D"
v.get(4)   # => nil

Parameters:

  • index (Integer) —

    The index to retrieve

Returns:

  • (Object) 


223
224
225
226
227
228
 
# File 'lib/immutable/vector.rb', line 223

def get(index)
  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

#hash ⇒ Integer

See ‘Object#hash`.

Returns:

  • (Integer) 


1318
1319
1320
 
# File 'lib/immutable/vector.rb', line 1318

def hash
  reduce(0) { |hash, item| (hash << 5) - hash + item.hash }
end

#insert(index, *items) ⇒ Vector

Return a new ‘Vector` with the given values inserted before the element at `index`. If `index` is greater than the current length, `nil` values are added to pad the `Vector` to the required size.

Examples:

Immutable::Vector["A", "B", "C", "D"].insert(2, "X", "Y", "Z")
# => Immutable::Vector["A", "B", "X", "Y", "Z", "C", "D"]
Immutable::Vector[].insert(2, "X", "Y", "Z")
# => Immutable::Vector[nil, nil, "X", "Y", "Z"]

Parameters:

  • index (Integer) —

    The index where the new items should go

  • items (Array) —

    The items to add

Returns:

Raises:

  • (IndexError) —

    if index exceeds negative range.



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/immutable/vector.rb', line 374

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

#last ⇒ Object

Return the last item in the ‘Vector`. If the vector is empty, return `nil`.

Examples:

Immutable::Vector["A", "B", "C"].last  # => "C"

Returns:

  • (Object) 


121
122
123
 
# File 'lib/immutable/vector.rb', line 121

def last
  get(-1)
end

#map ⇒ Vector, Enumerator Also known as: collect

Invoke the given block once for each item in the vector, and return a new ‘Vector` containing the values returned by the block. If no block is provided, return an enumerator.

Examples:

Immutable::Vector[3, 2, 1].map { |e| e * e }  # => Immutable::Vector[9, 4, 1]

Returns:



516
517
518
519
520
 
# File 'lib/immutable/vector.rb', line 516

def map
  return enum_for(:map) if not block_given?
  return self if empty?
  self.class.new(super)
end

#marshal_dump ⇒ ::Array

Returns:

  • (::Array) 


1332
1333
1334
 
# File 'lib/immutable/vector.rb', line 1332

def marshal_dump
  to_a
end

#marshal_load(array) ⇒ Object 



1337
1338
1339
 
# File 'lib/immutable/vector.rb', line 1337

def marshal_load(array)
  initialize(array.freeze)
end

#permutation(n = @size) ⇒ self, Enumerator

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.

Examples:

v = Immutable::Vector[5, 6, 7]
v.permutation(2) { |p| puts "Permutation: #{p}" }

Permutation: [5, 6]
Permutation: [5, 7]
Permutation: [6, 5]
Permutation: [6, 7]
Permutation: [7, 5]
Permutation: [7, 6]
# => Immutable::Vector[5, 6, 7]

Returns:

  • (self, Enumerator) 


960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
 
# File 'lib/immutable/vector.rb', line 960

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

#pop ⇒ Vector

Return a new ‘Vector` with the last element removed. Return `self` if empty.

Examples:

Immutable::Vector["A", "B", "C"].pop  # => Immutable::Vector["A", "B"]

Returns:



415
416
417
418
 
# File 'lib/immutable/vector.rb', line 415

def pop
  return self if @size == 0
  replace_suffix(@size-1, [])
end

#product(*vectors) ⇒ Vector #product ⇒ Vector

Cartesian product or multiplication.

Overloads:

  • #product(*vectors) ⇒ Vector

    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.

    Examples:

    v1 = Immutable::Vector[1, 2, 3]
v2 = Immutable::Vector["A", "B"]
v1.product(v2)
# => [[1, "A"], [1, "B"], [2, "A"], [2, "B"], [3, "A"], [3, "B"]]
  • #product ⇒ Vector

    Return the result of multiplying all the items in this ‘Vector` together.

    Examples:

    Immutable::Vector[1, 2, 3, 4, 5].product  # => 120

Returns:



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
 
# File 'lib/immutable/vector.rb', line 1058

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

#rassoc(obj) ⇒ Object

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. Behaviour is undefined when elements do not meet assumptions (i.e. are not indexable collections).

Examples:

v = Immutable::Vector[["A", 10], ["B", 20], ["C", 30]]
v.rassoc(20)  # => ["B", 20]

Parameters:

  • obj (Object) —

    The object to search for

Returns:

  • (Object) 


1283
1284
1285
1286
1287
1288
1289
 
# File 'lib/immutable/vector.rb', line 1283

def rassoc(obj)
  each do |array|
    next if !array.respond_to?(:[])
    return array if obj == array[1]
  end
  nil
end

#repeated_combination(n) ⇒ self, Enumerator

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.

Examples:

v = Immutable::Vector[5, 6, 7, 8]
v.repeated_combination(2) { |c| puts "Combination: #{c}" }

Combination: [5, 5]
Combination: [5, 6]
Combination: [5, 7]
Combination: [5, 8]
Combination: [6, 6]
Combination: [6, 7]
Combination: [6, 8]
Combination: [7, 7]
Combination: [7, 8]
Combination: [8, 8]
# => Immutable::Vector[5, 6, 7, 8]

Returns:

  • (self, Enumerator) 


910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
 
# File 'lib/immutable/vector.rb', line 910

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

#repeated_permutation(n = @size) ⇒ self, Enumerator

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.

Examples:

v = Immutable::Vector[5, 6, 7]
v.repeated_permutation(2) { |p| puts "Permutation: #{p}" }

Permutation: [5, 5]
Permutation: [5, 6]
Permutation: [5, 7]
Permutation: [6, 5]
Permutation: [6, 6]
Permutation: [6, 7]
Permutation: [7, 5]
Permutation: [7, 6]
Permutation: [7, 7]
# => Immutable::Vector[5, 6, 7]

Returns:

  • (self, Enumerator) 


1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/immutable/vector.rb', line 1015

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

#reverse ⇒ Vector

Return a new ‘Vector` with the same elements as this one, but in reverse order.

Examples:

Immutable::Vector["A", "B", "C"].reverse  # => Immutable::Vector["C", "B", "A"]

Returns:



572
573
574
 
# File 'lib/immutable/vector.rb', line 572

def reverse
  self.class.new(((array = to_a).frozen? ? array.reverse : array.reverse!).freeze)
end

#reverse_each(&block) ⇒ self

Call the given block once for each item in the vector, from last to first.

Examples:

Immutable::Vector["A", "B", "C"].reverse_each { |e| puts "Element: #{e}" }

Element: C
Element: B
Element: A

Returns:

  • (self) 


474
475
476
477
478
 
# File 'lib/immutable/vector.rb', line 474

def reverse_each(&block)
  return enum_for(:reverse_each) unless block_given?
  reverse_traverse_depth_first(@root, @levels, &block)
  self
end

#rindex(obj) ⇒ Integer #rindex {|element| ... } ⇒ Integer

Find the index of an element, starting from the end of the vector. Returns ‘nil` if no element is found.

Overloads:

  • #rindex(obj) ⇒ Integer

    Return the index of the last element which is ‘#==` to `obj`.

    Examples:

    v = Immutable::Vector[7, 8, 9, 7, 8, 9]
v.rindex(8) # => 4
  • #rindex {|element| ... } ⇒ Integer

    Return the index of the last element for which the block returns true.

    Examples:

    v = Immutable::Vector[7, 8, 9, 7, 8, 9]
v.rindex { |e| e.even? }  # => 4

    Yields:

    • (element) —

      Once for each element, last to first, until the block returns true.

Returns:

  • (Integer) 


1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/immutable/vector.rb', line 1236

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

#rotate(count = 1) ⇒ Vector

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.

Examples:

v = Immutable::Vector["A", "B", "C", "D", "E", "F"]
v.rotate(2)   # => Immutable::Vector["C", "D", "E", "F", "A", "B"]
v.rotate(-1)  # => Immutable::Vector["F", "A", "B", "C", "D", "E"]

Parameters:

  • count (Integer) (defaults to: 1) —

    The number of positions to shift items by

Returns:



589
590
591
592
 
# File 'lib/immutable/vector.rb', line 589

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

#sample ⇒ Object

Return a randomly chosen item from this ‘Vector`. If the vector is empty, return `nil`.

Examples:

Immutable::Vector[1, 2, 3, 4, 5].sample  # => 2

Returns:

  • (Object) 


1198
1199
1200
 
# File 'lib/immutable/vector.rb', line 1198

def sample
  get(rand(@size))
end

#select {|element| ... } ⇒ Vector Also known as: find_all, keep_if

Return a new ‘Vector` containing all elements for which the given block returns true.

Examples:

Immutable::Vector["Bird", "Cow", "Elephant"].select { |e| e.size >= 4 }
# => Immutable::Vector["Bird", "Elephant"]

Yields:

  • (element) —

    Once for each element.

Returns:



489
490
491
492
 
# File 'lib/immutable/vector.rb', line 489

def select
  return enum_for(:select) unless block_given?
  reduce(self.class.empty) { |vector, item| yield(item) ? vector.add(item) : vector }
end

#set(index, item) ⇒ Vector #set(index) {|existing| ... } ⇒ Vector

Return a new ‘Vector` with a new value at the given `index`. If `index` is greater than the length of the vector, the returned vector will be padded with `nil`s to the correct size.

Overloads:

  • #set(index, item) ⇒ Vector

    Return a new ‘Vector` with the item at `index` replaced by `item`.

    Examples:

    Immutable::Vector[1, 2, 3, 4].set(2, 99)
# => Immutable::Vector[1, 2, 99, 4]
Immutable::Vector[1, 2, 3, 4].set(-1, 99)
# => Immutable::Vector[1, 2, 3, 99]
Immutable::Vector[].set(2, 99)
# => Immutable::Vector[nil, nil, 99]

    Parameters:

    • item (Object) —

      The object to insert into that position

  • #set(index) {|existing| ... } ⇒ Vector

    Return a new ‘Vector` with the item at `index` replaced by the return value of the block.

    Examples:

    Immutable::Vector[1, 2, 3, 4].set(2) { |v| v * 10 }
# => Immutable::Vector[1, 2, 30, 4]

    Yields:

    • (existing) —

      Once with the existing value at the given ‘index`.

Parameters:

  • index (Integer) —

    The index to update. May be negative.

Returns:

Raises:

  • (IndexError) 


165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/immutable/vector.rb', line 165

def set(index, item = yield(get(index)))
  raise IndexError, "index #{index} outside of vector bounds" if index < -@size
  index += @size if index < 0
  if index > @size
    suffix = Array.new(index - @size, nil)
    suffix << item
    replace_suffix(@size, suffix)
  else
    update_root(index, item)
  end
end

#shift ⇒ Vector

Return a new ‘Vector` with the first element removed. If empty, return `self`.

Examples:

Immutable::Vector["A", "B", "C"].shift  # => Immutable::Vector["B", "C"]

Returns:



440
441
442
 
# File 'lib/immutable/vector.rb', line 440

def shift
  delete_at(0)
end

#shuffle ⇒ Vector

Return a new ‘Vector` with the same elements as this one, but randomly permuted.

Examples:

Immutable::Vector[1, 2, 3, 4].shuffle  # => Immutable::Vector[4, 1, 3, 2]

Returns:



543
544
545
 
# File 'lib/immutable/vector.rb', line 543

def shuffle
  self.class.new(((array = to_a).frozen? ? array.shuffle : array.shuffle!).freeze)
end

#vector.slice(index) ⇒ Object #vector.slice(index, length) ⇒ Vector #vector.slice(index..end) ⇒ Vector Also known as: []

Return specific objects from the ‘Vector`. All overloads return `nil` if the starting index is out of range.

Overloads:

  • #vector.slice(index) ⇒ Object

    Returns a single object at the given ‘index`. If `index` is negative, count backwards from the end.

    Examples:

    v = Immutable::Vector["A", "B", "C", "D", "E", "F"]
v[2]  # => "C"
v[-1] # => "F"
v[6]  # => nil

    Parameters:

    • index (Integer) —

      The index to retrieve. May be negative.

    Returns:

    • (Object)
  • #vector.slice(index, length) ⇒ Vector

    Return a subvector starting at ‘index` and continuing for `length` elements or until the end of the `Vector`, whichever occurs first.

    Examples:

    v = Immutable::Vector["A", "B", "C", "D", "E", "F"]
v[2, 3]  # => Immutable::Vector["C", "D", "E"]
v[-2, 3] # => Immutable::Vector["E", "F"]
v[20, 1] # => nil

    Parameters:

    • start (Integer) —

      The index to start retrieving items from. May be negative.

    • length (Integer) —

      The number of items to retrieve.

    Returns:

  • #vector.slice(index..end) ⇒ Vector

    Return a subvector starting at ‘index` and continuing to index `end` or the end of the `Vector`, whichever occurs first.

    Examples:

    v = Immutable::Vector["A", "B", "C", "D", "E", "F"]
v[2..3]    # => Immutable::Vector["C", "D"]
v[-2..100] # => Immutable::Vector["E", "F"]
v[20..21]  # => nil

    Parameters:

    • range (Range) —

      The range of indices to retrieve.

    Returns:



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/immutable/vector.rb', line 340

def slice(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

#sort ⇒ Vector #sort {|a, b| ... } ⇒ Vector

Return a new ‘Vector` with the same items, but sorted.

Overloads:

  • #sort ⇒ Vector

    Compare elements with their natural sort key (‘#<=>`).

    Examples:

    Immutable::Vector["Elephant", "Dog", "Lion"].sort
# => Immutable::Vector["Dog", "Elephant", "Lion"]
  • #sort {|a, b| ... } ⇒ Vector

    Uses the block as a comparator to determine sorted order.

    Examples:

    Immutable::Vector["Elephant", "Dog", "Lion"].sort { |a,b| a.size <=> b.size }
# => Immutable::Vector["Dog", "Lion", "Elephant"]

    Yields:

    • (a, b) —

      Any number of times with different pairs of elements.

    Yield Returns:

    • (Integer) —

      Negative if the first element should be sorted lower, positive if the latter element, or 0 if equal.

Returns:



692
693
694
 
# File 'lib/immutable/vector.rb', line 692

def sort
  self.class.new(super)
end

#sort_by {|element| ... } ⇒ Vector

Return a new ‘Vector` with the same items, but sorted. The sort order is determined by mapping the items through the given block to obtain sort keys, and then sorting the keys according to their natural sort order (`#<=>`).

Examples:

Immutable::Vector["Elephant", "Dog", "Lion"].sort_by { |e| e.size }
# => Immutable::Vector["Dog", "Lion", "Elephant"]

Yields:

  • (element) —

    Once for each element.

Yield Returns:

  • a sort key object for the yielded element.

Returns:



708
709
710
 
# File 'lib/immutable/vector.rb', line 708

def sort_by
  self.class.new(super)
end

#take(n) ⇒ Vector

Return only the first ‘n` elements in a new `Vector`.

Examples:

Immutable::Vector["A", "B", "C", "D", "E", "F"].take(4)
# => Immutable::Vector["A", "B", "C", "D"]

Parameters:

  • n (Integer) —

    The number of elements to retain

Returns:



736
737
738
739
 
# File 'lib/immutable/vector.rb', line 736

def take(n)
  return self if n >= @size
  self.class.new(super)
end

#take_while ⇒ Vector, Enumerator

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.

Examples:

Immutable::Vector[1, 3, 5, 7, 6, 4, 2].take_while { |e| e < 5 }
# => Immutable::Vector[1, 3]

Returns:



764
765
766
767
 
# File 'lib/immutable/vector.rb', line 764

def take_while
  return enum_for(:take_while) if not block_given?
  self.class.new(super)
end

#to_a ⇒ Array Also known as: to_ary

Return an ‘Array` with the same elements, in the same order. The returned `Array` may or may not be frozen.

Returns:

  • (Array) 


1295
1296
1297
1298
1299
1300
1301
1302
1303
 
# File 'lib/immutable/vector.rb', line 1295

def to_a
  if @levels == 0
    # When initializing a Vector with 32 or less items, we always make
    # sure @root is frozen, so we can return it directly here
    @root
  else
    flatten_node(@root, @levels * BITS_PER_LEVEL, [])
  end
end

#transpose ⇒ Vector

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.

Examples:

Immutable::Vector[["A", 10], ["B", 20], ["C", 30]].transpose
# => Immutable::Vector[Immutable::Vector["A", "B", "C"], Immutable::Vector[10, 20, 30]]

Returns:

Raises:

  • (IndexError) —

    if elements are not of the same size.

  • (TypeError) —

    if an element can not be implicitly converted to an array (using ‘#to_ary`)



1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'lib/immutable/vector.rb', line 1118

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

#uniq(&block) ⇒ Vector

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.

Examples:

Immutable::Vector["A", "B", "C", "B"].uniq      # => Immutable::Vector["A", "B", "C"]
Immutable::Vector["a", "A", "b"].uniq(&:upcase) # => Immutable::Vector["a", "b"]

Returns:



555
556
557
558
559
560
561
562
563
564
 
# File 'lib/immutable/vector.rb', line 555

def uniq(&block)
  array = self.to_a
  if array.frozen?
    self.class.new(array.uniq(&block).freeze)
  elsif array.uniq!(&block) # returns nil if no changes were made
    self.class.new(array.freeze)
  else
    self
  end
end

#unshift(object) ⇒ Vector

Return a new ‘Vector` with `object` inserted before the first element, moving the other elements upwards.

Examples:

Immutable::Vector["A", "B"].unshift("Z")
# => Immutable::Vector["Z", "A", "B"]

Parameters:

  • object (Object) —

    The value to prepend

Returns:



429
430
431
 
# File 'lib/immutable/vector.rb', line 429

def unshift(object)
  insert(0, object)
end

#update_in(*key_path) {|value| ... } ⇒ Vector

Return a new ‘Vector` with a deeply nested value modified to the result of the given code block. When traversing the nested `Vector`s and `Hash`es, non-existing keys are created with empty `Hash` values.

The code block receives the existing value of the deeply nested key (or ‘nil` if it doesn’t exist). This is useful for “transforming” the value associated with a certain key.

Note that the original ‘Vector` and sub-`Vector`s and sub-`Hash`es are left unmodified; new data structure copies are created along the path wherever needed.

Examples:

v = Immutable::Vector[123, 456, 789, Immutable::Hash["a" => Immutable::Vector[5, 6, 7]]]
v.update_in(3, "a", 1) { |value| value + 9 }
# => Immutable::Vector[123, 456, 789, Immutable::Hash["a" => Immutable::Vector[5, 15, 7]]]

Parameters:

  • key_path (Object(s)) —

    List of keys which form the path to the key to be modified

Yields:

  • (value) —

    The previously stored value

Yield Returns:

  • (Object) —

    The new value to store

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/immutable/vector.rb', line 198

def update_in(*key_path, &block)
  if key_path.empty?
    raise ArgumentError, "must have at least one key in path"
  end
  key = key_path[0]
  if key_path.size == 1
    new_value = block.call(get(key))
  else
    value = fetch(key, Immutable::EmptyHash)
    new_value = value.update_in(*key_path[1..-1], &block)
  end
  set(key, new_value)
end

#values_at(*indices) ⇒ Vector

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.

Examples:

v = Immutable::Vector["A", "B", "C", "D", "E", "F"]
v.values_at(2, 4, 5)   # => Immutable::Vector["C", "E", "F"]

Parameters:

  • indices (Array) —

    The indices to retrieve and gather into a new ‘Vector`

Returns:



1212
1213
1214
 
# File 'lib/immutable/vector.rb', line 1212

def values_at(*indices)
  self.class.new(indices.map { |i| get(i) }.freeze)
end

#zip(*others) ⇒ Vector #zip(*others) {|pair| ... } ⇒ nil

Combine two vectors by “zipping” them together. ‘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 ‘others` contains fewer elements than this vector, `nil` will be used for padding.

Examples:

v1 = Immutable::Vector["A", "B", "C"]
v2 = Immutable::Vector[1, 2]
v1.zip(v2)
# => Immutable::Vector[["A", 1], ["B", 2], ["C", nil]]

Overloads:

  • #zip(*others) ⇒ Vector

    Return a new vector containing the new arrays.

    Returns:

  • #zip(*others) {|pair| ... } ⇒ nil

    Yields:

    • (pair) —

      once for each array

    Returns:

    • (nil)

Parameters:

  • others (Array) —

    The arrays/vectors to zip together with this one

Returns:



663
664
665
666
667
668
669
 
# File 'lib/immutable/vector.rb', line 663

def zip(*others)
  if block_given?
    super
  else
    self.class.new(super)
  end
end