class Enumerator::Product
Enumerator::Product generates a Cartesian product of any number of enumerable objects. Iterating over the product of enumerable objects is roughly equivalent to nested each_entry loops where the loop for the rightmost object is put innermost.
innings = Enumerator::Product.new(1..9, ['top', 'bottom']) innings.each do |i, h| p [i, h] end # [1, "top"] # [1, "bottom"] # [2, "top"] # [2, "bottom"] # [3, "top"] # [3, "bottom"] # ... # [9, "top"] # [9, "bottom"]
The method used against each enumerable object is each_entry instead of each so that the product of N enumerable objects yields an array of exactly N elements in each iteration.
When no enumerator is given, it calls a given block once yielding an empty argument list.
This type of objects can be created by Enumerator.product.
Public Class Methods
(*_EachEntry[Elem]) → voidSource
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/enumerator/product.rbs, line 45
def initialize: (*_EachEntry[Elem]) -> void
Generates a new enumerator object that generates a Cartesian product of given enumerable objects.
e = Enumerator::Product.new(1..3, [4, 5]) e.to_a #=> [[1, 4], [1, 5], [2, 4], [2, 5], [3, 4], [3, 5]] e.size #=> 6
Public Instance Methods
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/enumerator/product.rbs, line 58
def each: () { (Array[Elem]) -> void } -> self
Iterates over the elements of the first enumerable by calling the “each_entry” method on it with the given arguments, then proceeds to the following enumerables in sequence until all of the enumerables are exhausted.
If no block is given, returns an enumerator. Otherwise, returns self.
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/enumerator/product.rbs, line 90
def initialize_copy: (Product[Elem]) -> void
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/enumerator/product.rbs, line 66
def inspect: () -> String
Returns a printable version of the product enumerator.
() → selfSource
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/enumerator/product.rbs, line 76
def rewind: () -> self
Rewinds the product enumerator by calling the “rewind” method on each enumerable in reverse order. Each call is performed only if the enumerable responds to the method.
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/core/enumerator/product.rbs, line 86
def size: () -> (Integer | Float | nil)
Returns the total size of the enumerator product calculated by multiplying the sizes of enumerables in the product. If any of the enumerables reports its size as nil or Float::INFINITY, that value is returned as the size.