rbs 4.1.0.pre.2-java

data/core/enumerator/arithmetic_sequence.rbs

@@ -0,0 +1,70 @@
+# <!-- rdoc-file=enumerator.c -->
+# Enumerator::ArithmeticSequence is a subclass of Enumerator, that is a
+# representation of sequences of numbers with common difference. Instances of
+# this class can be generated by the Range#step and Numeric#step methods.
+#
+# The class can be used for slicing Array (see Array#slice) or custom
+# collections.
+#
+class Enumerator::ArithmeticSequence < Enumerator[Numeric]
+  # <!--
+  #   rdoc-file=enumerator.c
+  #   - aseq.begin -> num or nil
+  # -->
+  # Returns the number that defines the first element of this arithmetic sequence.
+  #
+  def begin: () -> Numeric?
+
+  # <!--
+  #   rdoc-file=enumerator.c
+  #   - aseq.end -> num or nil
+  # -->
+  # Returns the number that defines the end of this arithmetic sequence.
+  #
+  def end: () -> Numeric?
+
+  # <!--
+  #   rdoc-file=enumerator.c
+  #   - aseq.each {|i| block } -> aseq
+  #   - aseq.each              -> aseq
+  # -->
+  #
+  def each: () ?{ (Numeric) -> void } -> self
+
+  # <!--
+  #   rdoc-file=enumerator.c
+  #   - aseq.exclude_end? -> true or false
+  # -->
+  # Returns `true` if this arithmetic sequence excludes its end value.
+  #
+  def exclude_end?: () -> bool
+
+  # <!--
+  #   rdoc-file=enumerator.c
+  #   - aseq.last    -> num or nil
+  #   - aseq.last(n) -> an_array
+  # -->
+  # Returns the last number in this arithmetic sequence, or an array of the last
+  # `n` elements.
+  #
+  def last: () -> Numeric?
+          | (Integer n) -> Array[Numeric]
+
+  # <!--
+  #   rdoc-file=enumerator.c
+  #   - aseq.size -> num or nil
+  # -->
+  # Returns the number of elements in this arithmetic sequence if it is a finite
+  # sequence.  Otherwise, returns `nil`.
+  #
+  def size: () -> (Integer | Float)
+
+  # <!--
+  #   rdoc-file=enumerator.c
+  #   - aseq.step -> num
+  # -->
+  # Returns the number that defines the common difference between two adjacent
+  # elements in this arithmetic sequence.
+  #
+  def step: () -> Numeric
+end

data/core/enumerator/product.rbs

@@ -0,0 +1,92 @@
+%a{annotate:rdoc:skip}
+class Enumerator[unchecked out E, out R = void]
+  # <!-- rdoc-file=enumerator.c -->
+  # 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.
+  #
+  class Product[unchecked out E] < Enumerator[Array[E], Product[E]]
+    # <!--
+    #   rdoc-file=enumerator.c
+    #   - Enumerator::Product.new(*enums) -> enum
+    # -->
+    # 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
+    #
+    def initialize: (*_EachEntry[E]) -> void
+
+    # <!--
+    #   rdoc-file=enumerator.c
+    #   - obj.each { |...| ... } -> obj
+    #   - obj.each -> enumerator
+    # -->
+    # 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.
+    #
+    def each: () { (Array[E]) -> void } -> self
+
+    # <!--
+    #   rdoc-file=enumerator.c
+    #   - obj.inspect -> string
+    # -->
+    # Returns a printable version of the product enumerator.
+    #
+    def inspect: () -> String
+
+    # <!--
+    #   rdoc-file=enumerator.c
+    #   - obj.rewind -> obj
+    # -->
+    # 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.
+    #
+    def rewind: () -> self
+
+    # <!--
+    #   rdoc-file=enumerator.c
+    #   - obj.size -> int, Float::INFINITY or 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.
+    #
+    def size: () -> (Integer | Float | nil)
+
+    private
+
+    def initialize_copy: (Product[E]) -> void
+  end
+end