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, #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:



768
769
770
771
772
773
 
# File 'lib/immutable/vector.rb', line 768

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:



621
622
623
624
625
 
# File 'lib/immutable/vector.rb', line 621

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) 


1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/immutable/vector.rb', line 1253

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.



1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'lib/immutable/vector.rb', line 1147

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:



1178
1179
1180
 
# File 'lib/immutable/vector.rb', line 1178

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) 


847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/immutable/vector.rb', line 847

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:



486
487
488
 
# File 'lib/immutable/vector.rb', line 486

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:



382
383
384
385
386
387
388
 
# File 'lib/immutable/vector.rb', line 382

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

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



711
712
713
714
715
716
 
# File 'lib/immutable/vector.rb', line 711

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:



740
741
742
743
 
# File 'lib/immutable/vector.rb', line 740

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:



1315
1316
1317
 
# File 'lib/immutable/vector.rb', line 1315

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) 


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

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) 


1300
1301
1302
1303
1304
 
# File 'lib/immutable/vector.rb', line 1300

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.



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/immutable/vector.rb', line 812

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:



513
514
515
516
517
 
# File 'lib/immutable/vector.rb', line 513

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:



600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/immutable/vector.rb', line 600

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) 


1308
1309
1310
 
# File 'lib/immutable/vector.rb', line 1308

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.



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/immutable/vector.rb', line 356

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:



498
499
500
501
502
 
# File 'lib/immutable/vector.rb', line 498

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

#marshal_dump ⇒ ::Array

Returns:

  • (::Array) 


1322
1323
1324
 
# File 'lib/immutable/vector.rb', line 1322

def marshal_dump
  to_a
end

#marshal_load(array) ⇒ Object 



1327
1328
1329
 
# File 'lib/immutable/vector.rb', line 1327

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) 


950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/immutable/vector.rb', line 950

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:



397
398
399
400
 
# File 'lib/immutable/vector.rb', line 397

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:



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
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
 
# File 'lib/immutable/vector.rb', line 1048

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) 


1273
1274
1275
1276
1277
1278
1279
 
# File 'lib/immutable/vector.rb', line 1273

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) 


900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
 
# File 'lib/immutable/vector.rb', line 900

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) 


1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/immutable/vector.rb', line 1005

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:



562
563
564
 
# File 'lib/immutable/vector.rb', line 562

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) 


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

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) 


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/immutable/vector.rb', line 1226

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:



579
580
581
582
 
# File 'lib/immutable/vector.rb', line 579

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) 


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

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:



471
472
473
474
 
# File 'lib/immutable/vector.rb', line 471

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:



422
423
424
 
# File 'lib/immutable/vector.rb', line 422

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:



525
526
527
 
# File 'lib/immutable/vector.rb', line 525

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:



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/immutable/vector.rb', line 322

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:



682
683
684
 
# File 'lib/immutable/vector.rb', line 682

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:



698
699
700
 
# File 'lib/immutable/vector.rb', line 698

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:



726
727
728
729
 
# File 'lib/immutable/vector.rb', line 726

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:



754
755
756
757
 
# File 'lib/immutable/vector.rb', line 754

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) 


1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'lib/immutable/vector.rb', line 1285

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



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/immutable/vector.rb', line 1108

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:



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/immutable/vector.rb', line 537

def uniq(&block)
  array = self.to_a
  if block_given?
    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
  elsif array.frozen?
    self.class.new(array.uniq.freeze)
  elsif array.uniq! # 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:



411
412
413
 
# File 'lib/immutable/vector.rb', line 411

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:



1202
1203
1204
 
# File 'lib/immutable/vector.rb', line 1202

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:



653
654
655
656
657
658
659
 
# File 'lib/immutable/vector.rb', line 653

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