rbs 2.0.0 → 2.1.0

data/stdlib/prettyprint/0/prettyprint.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=lib/prettyprint.rb -->
 # This class implements a pretty printing algorithm. It finds line breaks and
 # nice indentations for grouped structure.
 #
@@ -31,11 +32,16 @@
 #
 # ## Author
 # Tanaka Akira <akr@fsij.org>
+#
 class PrettyPrint
   interface _Output
     def <<: (String) -> void
   end
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - format(output=''.dup, maxwidth=79, newline="\n", genspace=lambda {|n| ' ' * n}) { |q| ... }
+  # -->
   # This is a convenience method which is same as follows:
   #
   #     begin
@@ -47,6 +53,10 @@ class PrettyPrint
   #
   def self.format: (?untyped output, ?Integer maxwidth, ?String newline, ?^(Integer) -> Integer genspace) { (PrettyPrint) -> untyped } -> _Output
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - singleline_format(output=''.dup, maxwidth=nil, newline=nil, genspace=nil) { |q| ... }
+  # -->
   # This is similar to PrettyPrint::format but the result has no breaks.
   #
   # `maxwidth`, `newline` and `genspace` are ignored.
@@ -54,8 +64,12 @@ class PrettyPrint
   # The invocation of `breakable` in the block doesn't break a line and is treated
   # as just an invocation of `text`.
   #
-  def self.singleline_format: (?untyped output, ?Integer? maxwidth, ?String? newline, ?^(Integer) -> Integer? genspace ) { (PrettyPrint::SingleLine) -> untyped } -> _Output
+  def self.singleline_format: (?untyped output, ?Integer? maxwidth, ?String? newline, ?^(Integer) -> Integer? genspace) { (PrettyPrint::SingleLine) -> untyped } -> _Output
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - new(output=''.dup, maxwidth=79, newline="\n", &genspace)
+  # -->
   # Creates a buffer for pretty printing.
   #
   # `output` is an output target. If it is not specified, '' is assumed. It should
@@ -73,36 +87,52 @@ class PrettyPrint
   # The block is used to generate spaces. {|width| ' ' * width} is used if it is
   # not given.
   #
-  def initialize: (?untyped output, ?Integer maxwidth, ?String newline, ?^(Integer) -> Integer genspace)  -> void
+  def initialize: (?untyped output, ?Integer maxwidth, ?String newline, ?^(Integer) -> Integer genspace) -> void
 
+  # <!-- rdoc-file=lib/prettyprint.rb -->
   # The output object.
   #
   # This defaults to '', and should accept the << method
+  #
   attr_reader output: _Output
 
+  # <!-- rdoc-file=lib/prettyprint.rb -->
   # The maximum width of a line, before it is separated in to a newline
   #
-  # This defaults to 79, and should be a Fixnum
+  # This defaults to 79, and should be an Integer
+  #
   attr_reader maxwidth: Integer
 
-  # The value that is appended to +output+ to add a new line.
+  # <!-- rdoc-file=lib/prettyprint.rb -->
+  # The value that is appended to `output` to add a new line.
+  #
+  # This defaults to "n", and should be String
   #
-  # This defaults to "\n", and should be String
   attr_reader newline: String
 
-  # A lambda or Proc, that takes one argument, of a Fixnum, and returns
-  # the corresponding number of spaces.
+  # <!-- rdoc-file=lib/prettyprint.rb -->
+  # A lambda or Proc, that takes one argument, of an Integer, and returns the
+  # corresponding number of spaces.
   #
   # By default this is:
-  #   lambda {|n| ' ' * n}
+  #     lambda {|n| ' ' * n}
+  #
   attr_reader genspace: Proc
 
+  # <!-- rdoc-file=lib/prettyprint.rb -->
   # The number of spaces to be indented
+  #
   attr_reader indent: Integer
 
+  # <!-- rdoc-file=lib/prettyprint.rb -->
   # The PrettyPrint::GroupQueue of groups in stack to be pretty printed
+  #
   attr_reader group_queue: PrettyPrint::GroupQueue
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - current_group()
+  # -->
   # Returns the group most recently added to the stack.
   #
   # Contrived example:
@@ -135,16 +165,28 @@ class PrettyPrint
   #
   def current_group: () -> PrettyPrint::Group
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - break_outmost_groups()
+  # -->
   # Breaks the buffer into lines that are shorter than #maxwidth
   #
-    def break_outmost_groups: () -> untyped
+  def break_outmost_groups: () -> untyped
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - text(obj, width=obj.length)
+  # -->
   # This adds `obj` as a text of `width` columns in width.
   #
   # If `width` is not specified, obj.length is used.
   #
   def text: (String obj, ?Integer width) -> void
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - fill_breakable(sep=' ', width=sep.length)
+  # -->
   # This is similar to #breakable except the decision to break or not is
   # determined individually.
   #
@@ -162,6 +204,10 @@ class PrettyPrint
   #
   def fill_breakable: (?String sep, ?Integer width) -> void
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - breakable(sep=' ', width=sep.length)
+  # -->
   # This says "you can break a line here if necessary", and a `width`-column text
   # `sep` is inserted if a line is not broken at the point.
   #
@@ -172,6 +218,10 @@ class PrettyPrint
   #
   def breakable: (?String sep, ?Integer width) -> void
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - group(indent=0, open_obj='', close_obj='', open_width=open_obj.length, close_width=close_obj.length) { || ... }
+  # -->
   # Groups line break hints added in the block. The line break hints are all to be
   # used or not.
   #
@@ -184,183 +234,154 @@ class PrettyPrint
   #
   def group: (?::Integer indent, ?::String open_obj, ?::String close_obj, ?Integer open_width, ?Integer close_width) { () -> untyped } -> Integer
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - group_sub() { || ... }
+  # -->
   # Takes a block and queues a new group that is indented 1 level further.
   #
   def group_sub: () { () -> untyped } -> untyped
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - nest(indent) { || ... }
+  # -->
   # Increases left margin after newline with `indent` for line breaks added in the
   # block.
   #
   def nest: (Integer indent) { () -> untyped } -> void
 
+  # <!--
+  #   rdoc-file=lib/prettyprint.rb
+  #   - flush()
+  # -->
   # outputs buffered data.
   #
   def flush: () -> Integer
 
   class Text
-    # Creates a new text object.
-    #
-    # This constructor takes no arguments.
-    #
-    # The workflow is to append a PrettyPrint::Text object to the buffer, and
-    # being able to call the buffer.last() to reference it.
-    #
-    # As there are objects, use PrettyPrint::Text#add to include the objects
-    # and the width to utilized by the String version of this object.
     def initialize: () -> void
 
-    # The total width of the objects included in this Text object.
     attr_reader width: Integer
 
-    # Render the String text of the objects that have been added to this Text object.
-    #
-    # Output the text to +out+, and increment the width to +output_width+
     def output: (untyped `out`, untyped output_width) -> untyped
 
-    # Include +obj+ in the objects to be pretty printed, and increment
-    # this Text object's total width by +width+
     def add: (untyped obj, Integer width) -> void
   end
 
   class Breakable
-    # Create a new Breakable object.
-    #
-    # Arguments:
-    # * +sep+ String of the separator
-    # * +width+ Fixnum width of the +sep+
-    # * +q+ parent PrettyPrint object, to base from
     def initialize: (String sep, Integer width, PrettyPrint q) -> void
 
-    # Holds the separator String
-    #
-    # The +sep+ argument from ::new
     attr_reader obj: String
 
-    # The width of +obj+ / +sep+
     attr_reader width: Integer
 
-    # The number of spaces to indent.
-    #
-    # This is inferred from +q+ within PrettyPrint, passed in ::new
     attr_reader indent: Integer
 
-    # Render the String text of the objects that have been added to this
-    # Breakable object.
-    #
-    # Output the text to +out+, and increment the width to +output_width+
     def output: (untyped `out`, Integer output_width) -> untyped
   end
 
   class Group
-    # The Group class is used for making indentation easier.
-    #
-    # While this class does neither the breaking into newlines nor indentation,
-    # it is used in a stack (as well as a queue) within PrettyPrint, to group
-    # objects.
-    #
-    # For information on using groups, see PrettyPrint#group
-    #
-    # This class is intended for internal use of the PrettyPrint buffers.
-    # :nodoc:
-    # Create a Group object
-    #
-    # Arguments:
-    # * +depth+ - this group's relation to previous groups
     def initialize: (untyped depth) -> void
 
-    # This group's relation to previous groups
     attr_reader depth: untyped
 
-    # Array to hold the Breakable objects for this Group
     attr_reader breakables: Array[PrettyPrint::Breakable]
 
-    # Makes a break for this Group, and returns true
     def break: () -> bool
 
-    # Boolean of whether this Group has made a break
     def break?: () -> bool
 
-    # Boolean of whether this Group has been queried for being first
-    #
-    # This is used as a predicate, and ought to be called first.
     def first?: () -> bool
   end
 
   class GroupQueue
-    # The GroupQueue class is used for managing the queue of Group to be pretty
-    # printed.
-    #
-    # This queue groups the Group objects, based on their depth.
-    #
-    # This class is intended for internal use of the PrettyPrint buffers.
-    # :nodoc:
-    # Create a GroupQueue object
-    #
-    # Arguments:
-    # * +groups+ - one or more PrettyPrint::Group objects
     def initialize: (*untyped groups) -> void
 
-    # Enqueue +group+
-    #
-    # This does not strictly append the group to the end of the queue,
-    # but instead adds it in line, base on the +group.depth+
     def enq: (untyped group) -> void
 
-    # Returns the outer group of the queue
     def deq: () -> (PrettyPrint::Group | nil)
 
-    # Remote +group+ from this queue
     def delete: (PrettyPrint::Group group) -> void
   end
 
+  # <!-- rdoc-file=lib/prettyprint.rb -->
   # PrettyPrint::SingleLine is used by PrettyPrint.singleline_format
   #
   # It is passed to be similar to a PrettyPrint object itself, by responding to:
-  # * #text
-  # * #breakable
-  # * #nest
-  # * #group
-  # * #flush
-  # * #first?
+  # *   #text
+  # *   #breakable
+  # *   #nest
+  # *   #group
+  # *   #flush
+  # *   #first?
+  #
   #
   # but instead, the output has no line breaks
   #
   class SingleLine
+    # <!--
+    #   rdoc-file=lib/prettyprint.rb
+    #   - new(output, maxwidth=nil, newline=nil)
+    # -->
     # Create a PrettyPrint::SingleLine object
     #
     # Arguments:
-    # * +output+ - String (or similar) to store rendered text. Needs to respond to '<<'
-    # * +maxwidth+ - Argument position expected to be here for compatibility.
-    #                This argument is a noop.
-    # * +newline+ - Argument position expected to be here for compatibility.
-    #               This argument is a noop.
+    # *   `output` - String (or similar) to store rendered text. Needs to respond to
+    #     '<<'
+    # *   `maxwidth` - Argument position expected to be here for compatibility.
+    #         This argument is a noop.
+    #
+    # *   `newline` - Argument position expected to be here for compatibility.
+    #         This argument is a noop.
+    #
     def initialize: (String | untyped output, ?Integer? maxwidth, ?String? newline) -> void
 
-    # Add +obj+ to the text to be output.
+    # <!--
+    #   rdoc-file=lib/prettyprint.rb
+    #   - text(obj, width=nil)
+    # -->
+    # Add `obj` to the text to be output.
+    #
+    # `width` argument is here for compatibility. It is a noop argument.
     #
-    # +width+ argument is here for compatibility. It is a noop argument.
     def text: (String obj, ?Integer? width) -> void
 
-    # Appends +sep+ to the text to be output. By default +sep+ is ' '
+    # <!--
+    #   rdoc-file=lib/prettyprint.rb
+    #   - breakable(sep=' ', width=nil)
+    # -->
+    # Appends `sep` to the text to be output. By default `sep` is ' '
+    #
+    # `width` argument is here for compatibility. It is a noop argument.
     #
-    # +width+ argument is here for compatibility. It is a noop argument.
     def breakable: (?String sep, ?Integer? width) -> void
 
     def nest: (untyped indent) { () -> untyped } -> void
 
+    # <!--
+    #   rdoc-file=lib/prettyprint.rb
+    #   - group(indent=nil, open_obj='', close_obj='', open_width=nil, close_width=nil) { || ... }
+    # -->
     # Opens a block for grouping objects to be pretty printed.
     #
     # Arguments:
-    # * +indent+ - noop argument. Present for compatibility.
-    # * +open_obj+ - text appended before the &blok. Default is ''
-    # * +close_obj+ - text appended after the &blok. Default is ''
-    # * +open_width+ - noop argument. Present for compatibility.
-    # * +close_width+ - noop argument. Present for compatibility.
+    # *   `indent` - noop argument. Present for compatibility.
+    # *   `open_obj` - text appended before the &blok. Default is ''
+    # *   `close_obj` - text appended after the &blok. Default is ''
+    # *   `open_width` - noop argument. Present for compatibility.
+    # *   `close_width` - noop argument. Present for compatibility.
+    #
     def group: (?Integer? indent, ?String open_obj, ?String close_obj, ?Integer? open_width, ?Integer? close_width) { () -> untyped } -> untyped
 
     def flush: () -> nil
 
+    # <!--
+    #   rdoc-file=lib/prettyprint.rb
+    #   - first?()
+    # -->
     # This is used as a predicate, and ought to be called first.
+    #
     def first?: () -> bool
   end
 end

data/stdlib/prime/0/integer-extension.rbs

@@ -1,23 +1,41 @@
+%a{annotate:rdoc:skip}
 class Integer
+  # <!--
+  #   rdoc-file=lib/prime.rb
+  #   - each_prime(ubound) { |prime| ... }
+  # -->
   # Iterates the given block over all prime numbers.
   #
-  # See Prime#each for more details.
+  # See `Prime`#each for more details.
   #
   def self.each_prime: (Integer) { (Integer) -> void } -> void
 
+  # <!--
+  #   rdoc-file=lib/prime.rb
+  #   - from_prime_division(pd)
+  # -->
   # Re-composes a prime factorization and returns the product.
   #
   # See Prime#int_from_prime_division for more details.
   #
   def self.from_prime_division: (Array[[ String ]]) -> Integer
 
+  # <!--
+  #   rdoc-file=lib/prime.rb
+  #   - prime_division(generator = Prime::Generator23.new)
+  # -->
   # Returns the factorization of `self`.
   #
   # See Prime#prime_division for more details.
   #
   def prime_division: (?Prime::PseudoPrimeGenerator) -> Array[[ Integer, Integer ]]
 
-  # Returns true if `self` is a prime number, else returns false.
+  # <!--
+  #   rdoc-file=lib/prime.rb
+  #   - prime?()
+  # -->
+  # Returns true if `self` is a prime number, else returns false. Not recommended
+  # for very big integers (> 10**23).
   #
   def prime?: () -> bool
 end

data/stdlib/prime/0/prime.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=lib/prime.rb -->
 # The set of all prime numbers.
 #
 # ## Example
@@ -30,7 +31,7 @@
 # few implementations of generator.
 #
 # `Prime`::`EratosthenesGenerator`
-# :   Uses eratosthenes' sieve.
+# :   Uses Eratosthenes' sieve.
 # `Prime`::`TrialDivisionGenerator`
 # :   Uses the trial division method.
 # `Prime`::`Generator23`
@@ -40,7 +41,6 @@
 #     for factorizing an integer which is not large but has many prime factors.
 #     e.g. for Prime#prime? .
 #
-#
 class Prime
   include Singleton
 
@@ -48,6 +48,10 @@ class Prime
 
   extend Enumerable[Integer]
 
+  # <!--
+  #   rdoc-file=lib/prime.rb
+  #   - each(ubound = nil, generator = EratosthenesGenerator.new, &block)
+  # -->
   # Iterates the given block over all prime numbers.
   #
   # ## Parameters
@@ -75,24 +79,38 @@ class Prime
   def self?.each: (?Integer? ubound, ?PseudoPrimeGenerator generator) { (Integer) -> void } -> void
                 | (?Integer? ubound, ?PseudoPrimeGenerator generator) -> PseudoPrimeGenerator
 
+  # <!--
+  #   rdoc-file=lib/prime.rb
+  #   - int_from_prime_division(pd)
+  # -->
   # Re-composes a prime factorization and returns the product.
   #
+  # For the decomposition:
+  #
+  #     [[p_1, e_1], [p_2, e_2], ..., [p_n, e_n]],
+  #
+  # it returns:
+  #
+  #     p_1**e_1 * p_2**e_2 * ... * p_n**e_n.
+  #
   # ## Parameters
   # `pd`
-  # :   Array of pairs of integers. The each internal pair consists of a prime
-  #     number -- a prime factor -- and a natural number -- an exponent.
+  # :   Array of pairs of integers. Each pair consists of a prime number -- a
+  #     prime factor -- and a natural number -- its exponent (multiplicity).
   #
   #
   # ## Example
-  # For `[[p_1, e_1], [p_2, e_2], ...., [p_n, e_n]]`, it returns:
-  #
-  #     p_1**e_1 * p_2**e_2 * .... * p_n**e_n.
-  #
-  #     Prime.int_from_prime_division([[2,2], [3,1]])  #=> 12
+  #     Prime.int_from_prime_division([[3, 2], [5, 1]])  #=> 45
+  #     3**2 * 5                                         #=> 45
   #
   def self?.int_from_prime_division: (Array[[ Integer, Integer ]]) -> Integer
 
-  # Returns true if `value` is a prime number, else returns false.
+  # <!--
+  #   rdoc-file=lib/prime.rb
+  #   - prime?(value, generator = Prime::Generator23.new)
+  # -->
+  # Returns true if `value` is a prime number, else returns false. Integer#prime?
+  # is much more performant.
   #
   # ## Parameters
   #
@@ -103,15 +121,30 @@ class Prime
   #
   def self?.prime?: (Integer value, ?PseudoPrimeGenerator generator) -> bool
 
+  # <!--
+  #   rdoc-file=lib/prime.rb
+  #   - prime_division(value, generator = Prime::Generator23.new)
+  # -->
   # Returns the factorization of `value`.
   #
+  # For an arbitrary integer:
+  #
+  #     p_1**e_1 * p_2**e_2 * ... * p_n**e_n,
+  #
+  # prime_division returns an array of pairs of integers:
+  #
+  #     [[p_1, e_1], [p_2, e_2], ..., [p_n, e_n]].
+  #
+  # Each pair consists of a prime number -- a prime factor -- and a natural number
+  # -- its exponent (multiplicity).
+  #
   # ## Parameters
   # `value`
   # :   An arbitrary integer.
   # `generator`
   # :   Optional. A pseudo-prime generator. `generator`.succ must return the next
-  #     pseudo-prime number in the ascending order. It must generate all prime
-  #     numbers, but may also generate non prime numbers too.
+  #     pseudo-prime number in ascending order. It must generate all prime
+  #     numbers, but may also generate non-prime numbers, too.
   #
   #
   # ### Exceptions
@@ -120,15 +153,9 @@ class Prime
   #
   #
   # ## Example
-  # For an arbitrary integer:
-  #
-  #     n = p_1**e_1 * p_2**e_2 * .... * p_n**e_n,
   #
-  # prime_division(n) returns:
-  #
-  #     [[p_1, e_1], [p_2, e_2], ...., [p_n, e_n]].
-  #
-  #     Prime.prime_division(12) #=> [[2,2], [3,1]]
+  #     Prime.prime_division(45)  #=> [[3, 2], [5, 1]]
+  #     3**2 * 5                  #=> 45
   #
   def self?.prime_division: (Integer, ?PseudoPrimeGenerator generator) -> Array[[ Integer, Integer ]]
 
@@ -136,33 +163,70 @@ class Prime
   #
   def self.instance: () -> Prime
 
+  # <!-- rdoc-file=lib/prime.rb -->
   # An abstract class for enumerating pseudo-prime numbers.
   #
   # Concrete subclasses should override succ, next, rewind.
   #
   class PseudoPrimeGenerator
+    # <!--
+    #   rdoc-file=lib/prime.rb
+    #   - new(ubound = nil)
+    # -->
+    #
     def initialize: (?Integer?) -> void
 
     include Enumerable[Integer]
 
-    attr_accessor upper_bound (): Integer?
+    # <!--
+    #   rdoc-file=lib/prime.rb
+    #   - upper_bound()
+    # -->
+    # ----
+    # <!--
+    #   rdoc-file=lib/prime.rb
+    #   - upper_bound=(ubound)
+    # -->
+    #
+    attr_accessor upper_bound(): Integer?
 
+    # <!--
+    #   rdoc-file=lib/prime.rb
+    #   - each() { |prime| ... }
+    # -->
     # Iterates the given block for each prime number.
     #
     def each: () { (Integer) -> void } -> void
 
+    # <!--
+    #   rdoc-file=lib/prime.rb
+    #   - next()
+    # -->
     # alias of `succ`.
     #
     def next: () -> Integer
 
+    # <!--
+    #   rdoc-file=lib/prime.rb
+    #   - rewind()
+    # -->
     # Rewinds the internal position for enumeration.
     #
     # See `Enumerator`#rewind.
     #
     def rewind: () -> void
 
+    # <!--
+    #   rdoc-file=lib/prime.rb
+    #   - size()
+    # -->
+    #
     def size: () -> Float
 
+    # <!--
+    #   rdoc-file=lib/prime.rb
+    #   - succ()
+    # -->
     # returns the next pseudo-prime number, and move the internal position forward.
     #
     # `PseudoPrimeGenerator`#succ raises `NotImplementedError`.
@@ -170,6 +234,7 @@ class Prime
     def succ: () -> Integer
   end
 
+  # <!-- rdoc-file=lib/prime.rb -->
   # An implementation of `PseudoPrimeGenerator`.
   #
   # Uses `EratosthenesSieve`.
@@ -177,12 +242,14 @@ class Prime
   class EratosthenesGenerator < PseudoPrimeGenerator
   end
 
+  # <!-- rdoc-file=lib/prime.rb -->
   # An implementation of `PseudoPrimeGenerator` which uses a prime table generated
   # by trial division.
   #
   class TrialDivisionGenerator < PseudoPrimeGenerator
   end
 
+  # <!-- rdoc-file=lib/prime.rb -->
   # Generates all integers which are greater than 2 and are not divisible by
   # either 2 or 3.
   #