rbs 2.0.0 → 2.2.2

data/core/numeric.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=numeric.c -->
 # Numeric is the class from which all higher-level numeric classes should
 # inherit.
 #
@@ -69,17 +70,206 @@
 #     puts tally * 2            #=> "||||"
 #     puts tally > 1            #=> true
 #
+# ## What's Here
+#
+# First, what's elsewhere. Class Numeric:
+#
+# *   Inherits from [class
+#     Object](Object.html#class-Object-label-What-27s+Here).
+# *   Includes [module
+#     Comparable](Comparable.html#module-Comparable-label-What-27s+Here).
+#
+#
+# Here, class Numeric provides methods for:
+#
+# *   [Querying](#class-Numeric-label-Querying)
+# *   [Comparing](#class-Numeric-label-Comparing)
+# *   [Converting](#class-Numeric-label-Converting)
+# *   [Other](#class-Numeric-label-Other)
+#
+#
+# ### Querying
+#
+#     #finite?
+# :       Returns true unless `self` is infinite or not a number.
+#
+#     #infinite?
+# :       Returns -1, `nil` or +1, depending on whether `self` is
+#         `-Infinity<tt>, finite, or <tt>+Infinity`.
+#
+#     #integer?
+# :       Returns whether `self` is an integer.
+#
+#     #negative?
+# :       Returns whether `self` is negative.
+#
+#     #nonzero?
+# :       Returns whether `self` is not zero.
+#
+#     #positive?
+# :       Returns whether `self` is positive.
+#
+#     #real?
+# :       Returns whether `self` is a real value.
+#
+#     #zero?
+# :       Returns whether `self` is zero.
+#
+#
+#
+# ### Comparing
+#
+#     [<=>](#method-i-3C-3D-3E)
+# :       Returns:
+#
+#     *   -1 if  `self` is less than the given value.
+#     *   0 if `self` is equal to the given value.
+#     *   1 if `self` is greater than the given value.
+#     *   `nil` if `self` and the given value are not comparable.
+#
+#     #eql?
+# :       Returns whether `self` and the given value have the same value and
+#         type.
+#
+#
+#
+# ### Converting
+#
+#     #% (aliased as #modulo)
+# :       Returns the remainder of `self` divided by the given value.
+#
+#     #-@
+# :       Returns the value of `self`, negated.
+#
+#     #abs (aliased as #magnitude)
+# :       Returns the absolute value of `self`.
+#
+#     #abs2
+# :       Returns the square of `self`.
+#
+#     #angle (aliased as #arg and #phase)
+# :       Returns 0 if `self` is positive, Math::PI otherwise.
+#
+#     #ceil
+# :       Returns the smallest number greater than or equal to `self`, to a
+#         given precision.
+#
+#     #coerce
+# :       Returns array `[coerced_self, coerced_other]` for the given other
+#         value.
+#
+#     #conj (aliased as #conjugate)
+# :       Returns the complex conjugate of `self`.
+#
+#     #denominator
+# :       Returns the denominator (always positive) of the Rational
+#         representation of `self`.
+#
+#     #div
+# :       Returns the value of `self` divided by the given value and converted
+#         to an integer.
+#
+#     #divmod
+# :       Returns array `[quotient, modulus]` resulting from dividing `self` the
+#         given divisor.
+#
+#     #fdiv
+# :       Returns the Float result of dividing `self` by the given divisor.
+#
+#     #floor
+# :       Returns the largest number less than or equal to `self`, to a given
+#         precision.
+#
+#     #i
+# :       Returns the Complex object `Complex(0, self)`. the given value.
+#
+#     #imaginary (aliased as #imag)
+# :       Returns the imaginary part of the `self`.
+#
+#     #numerator
+# :       Returns the numerator of the Rational representation of `self`; has
+#         the same sign as `self`.
+#
+#     #polar
+# :       Returns the array `[self.abs, self.arg]`.
+#
+#     #quo
+# :       Returns the value of `self` divided by the given value.
+#
+#     #real
+# :       Returns the real part of `self`.
+#
+#     #rect (aliased as #rectangular)
+# :       Returns the array `[self, 0]`.
+#
+#     #remainder
+# :       Returns `self-arg*(self/arg).truncate` for the given `arg`.
+#
+#     #round
+# :       Returns the value of `self` rounded to the nearest value for the given
+#         a precision.
+#
+#     #to_c
+# :       Returns the Complex representation of `self`.
+#
+#     #to_int
+# :       Returns the Integer representation of `self`, truncating if necessary.
+#
+#     #truncate
+# :       Returns `self` truncated (toward zero) to a given precision.
+#
+#
+#
+# ### Other
+#
+#     #clone
+# :       Returns `self`; does not allow freezing.
+#
+#     #dup (aliased as #+@)
+# :       Returns `self`.
+#
+#     #step
+# :       Invokes the given block with the sequence of specified numbers.
+#
 class Numeric
   include Comparable
 
   public
 
-  # `x.modulo(y)` means `x-y*(x/y).floor`.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - self % other -> real_numeric
+  # -->
+  # Returns `self` modulo `other` as a real number.
+  #
+  # Of the Core and Standard Library classes, only Rational uses this
+  # implementation.
   #
-  # Equivalent to `num.divmod(numeric)[1]`.
+  # For Rational `r` and real number `n`, these expressions are equivalent:
+  #
+  #     c % n
+  #     c-n*(c/n).floor
+  #     c.divmod(n)[1]
   #
   # See Numeric#divmod.
   #
+  # Examples:
+  #
+  #     r = Rational(1, 2)    # => (1/2)
+  #     r2 = Rational(2, 3)   # => (2/3)
+  #     r % r2                # => (1/2)
+  #     r % 2                 # => (1/2)
+  #     r % 2.0               # => 0.5
+  #
+  #     r = Rational(301,100) # => (301/100)
+  #     r2 = Rational(7,5)    # => (7/5)
+  #     r % r2                # => (21/100)
+  #     r % -r2               # => (-119/100)
+  #     (-r) % r2             # => (119/100)
+  #     (-r) %-r2             # => (-21/100)
+  #
+  # Numeric#modulo is an alias for Numeric#%.
+  #
   def %: (Numeric) -> Numeric
 
   # Performs addition: the class of the resulting object depends on the class of
@@ -87,7 +277,11 @@ class Numeric
   #
   def +: (Numeric) -> Numeric
 
-  # Unary Plus---Returns the receiver.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - +self -> self
+  # -->
+  # Returns `self`.
   #
   def +@: () -> Numeric
 
@@ -96,165 +290,267 @@ class Numeric
   #
   def -: (Numeric) -> Numeric
 
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - -self -> numeric
+  # -->
   # Unary Minus---Returns the receiver, negated.
   #
   def -@: () -> Numeric
 
-  # Returns zero if `number` equals `other`, otherwise returns `nil`.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - self <=> other -> zero or nil
+  # -->
+  # Returns zero if `self` is the same as `other`, `nil` otherwise.
+  #
+  # No subclass in the Ruby Core or Standard Library uses this implementation.
   #
   def <=>: (Numeric other) -> Integer
 
-  # Returns the absolute value of `num`.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - abs -> numeric
+  # -->
+  # Returns the absolute value of `self`.
   #
-  #     12.abs         #=> 12
-  #     (-34.56).abs   #=> 34.56
-  #     -34.56.abs     #=> 34.56
+  #     12.abs        #=> 12
+  #     (-34.56).abs  #=> 34.56
+  #     -34.56.abs    #=> 34.56
   #
   # Numeric#magnitude is an alias for Numeric#abs.
   #
   def abs: () -> Numeric
 
+  # <!--
+  #   rdoc-file=complex.c
+  #   - num.abs2  ->  real
+  # -->
   # Returns square of self.
   #
   def abs2: () -> Numeric
 
+  # <!-- rdoc-file=complex.c -->
   # Returns 0 if the value is positive, pi otherwise.
   #
   def angle: () -> Numeric
 
+  # <!--
+  #   rdoc-file=complex.c
+  #   - num.arg    ->  0 or float
+  #   - num.angle  ->  0 or float
+  #   - num.phase  ->  0 or float
+  # -->
   # Returns 0 if the value is positive, pi otherwise.
   #
   alias arg angle
 
-  # Returns the smallest number greater than or equal to `num` with a precision of
-  # `ndigits` decimal digits (default: 0).
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - ceil(digits = 0) -> integer or float
+  # -->
+  # Returns the smallest number that is greater than or equal to `self` with a
+  # precision of `digits` decimal digits.
   #
-  # Numeric implements this by converting its value to a Float and invoking
+  # Numeric implements this by converting `self` to a Float and invoking
   # Float#ceil.
   #
   def ceil: () -> Integer
           | (Integer digits) -> (Integer | Numeric)
 
-  # If `numeric` is the same type as `num`, returns an array `[numeric, num]`.
-  # Otherwise, returns an array with both `numeric` and `num` represented as Float
-  # objects.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - coerce(other) -> array
+  # -->
+  # Returns a 2-element array containing two numeric elements, formed from the two
+  # operands `self` and `other`, of a common compatible type.
+  #
+  # Of the Core and Standard Library classes, Integer, Rational, and Complex use
+  # this implementation.
+  #
+  # Examples:
+  #
+  #     i = 2                    # => 2
+  #     i.coerce(3)              # => [3, 2]
+  #     i.coerce(3.0)            # => [3.0, 2.0]
+  #     i.coerce(Rational(1, 2)) # => [0.5, 2.0]
+  #     i.coerce(Complex(3, 4))  # Raises RangeError.
+  #
+  #     r = Rational(5, 2)       # => (5/2)
+  #     r.coerce(2)              # => [(2/1), (5/2)]
+  #     r.coerce(2.0)            # => [2.0, 2.5]
+  #     r.coerce(Rational(2, 3)) # => [(2/3), (5/2)]
+  #     r.coerce(Complex(3, 4))  # => [(3+4i), ((5/2)+0i)]
   #
-  # This coercion mechanism is used by Ruby to handle mixed-type numeric
-  # operations: it is intended to find a compatible common type between the two
-  # operands of the operator.
+  #     c = Complex(2, 3)        # => (2+3i)
+  #     c.coerce(2)              # => [(2+0i), (2+3i)]
+  #     c.coerce(2.0)            # => [(2.0+0i), (2+3i)]
+  #     c.coerce(Rational(1, 2)) # => [((1/2)+0i), (2+3i)]
+  #     c.coerce(Complex(3, 4))  # => [(3+4i), (2+3i)]
   #
-  #     1.coerce(2.5)   #=> [2.5, 1.0]
-  #     1.2.coerce(3)   #=> [3.0, 1.2]
-  #     1.coerce(2)     #=> [2, 1]
+  # Raises an exception if any type conversion fails.
   #
   def coerce: (Numeric) -> [ Numeric, Numeric ]
 
+  # <!-- rdoc-file=complex.c -->
   # Returns self.
   #
   def conj: () -> Numeric
 
+  # <!--
+  #   rdoc-file=complex.c
+  #   - num.conj       ->  self
+  #   - num.conjugate  ->  self
+  # -->
   # Returns self.
   #
   def conjugate: () -> Numeric
 
+  # <!--
+  #   rdoc-file=rational.c
+  #   - num.denominator  ->  integer
+  # -->
   # Returns the denominator (always positive).
   #
   def denominator: () -> Integer
 
-  # Uses `/` to perform division, then converts the result to an integer. Numeric
-  # does not define the `/` operator; this is left to subclasses.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - div(other) -> integer
+  # -->
+  # Returns the quotient `self/other` as an integer (via `floor`), using method
+  # `/` in the derived class of `self`. (Numeric itself does not define method
+  # `/`.)
   #
-  # Equivalent to `num.divmod(numeric)[0]`.
-  #
-  # See Numeric#divmod.
+  # Of the Core and Standard Library classes, Float, Rational, and Complex use
+  # this implementation.
   #
   def div: (Numeric) -> Integer
 
-  # Returns an array containing the quotient and modulus obtained by dividing
-  # `num` by `numeric`.
-  #
-  # If `q, r = x.divmod(y)`, then
-  #
-  #     q = floor(x/y)
-  #     x = q*y + r
-  #
-  # The quotient is rounded toward negative infinity, as shown in the following
-  # table:
-  #
-  #      a    |  b  |  a.divmod(b)  |   a/b   | a.modulo(b) | a.remainder(b)
-  #     ------+-----+---------------+---------+-------------+---------------
-  #      13   |  4  |   3,    1     |   3     |    1        |     1
-  #     ------+-----+---------------+---------+-------------+---------------
-  #      13   | -4  |  -4,   -3     |  -4     |   -3        |     1
-  #     ------+-----+---------------+---------+-------------+---------------
-  #     -13   |  4  |  -4,    3     |  -4     |    3        |    -1
-  #     ------+-----+---------------+---------+-------------+---------------
-  #     -13   | -4  |   3,   -1     |   3     |   -1        |    -1
-  #     ------+-----+---------------+---------+-------------+---------------
-  #      11.5 |  4  |   2,    3.5   |   2.875 |    3.5      |     3.5
-  #     ------+-----+---------------+---------+-------------+---------------
-  #      11.5 | -4  |  -3,   -0.5   |  -2.875 |   -0.5      |     3.5
-  #     ------+-----+---------------+---------+-------------+---------------
-  #     -11.5 |  4  |  -3,    0.5   |  -2.875 |    0.5      |    -3.5
-  #     ------+-----+---------------+---------+-------------+---------------
-  #     -11.5 | -4  |   2,   -3.5   |   2.875 |   -3.5      |    -3.5
-  #
-  # Examples
-  #
-  #     11.divmod(3)        #=> [3, 2]
-  #     11.divmod(-3)       #=> [-4, -1]
-  #     11.divmod(3.5)      #=> [3, 0.5]
-  #     (-11).divmod(3.5)   #=> [-4, 3.0]
-  #     11.5.divmod(3.5)    #=> [3, 1.0]
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - divmod(other) -> array
+  # -->
+  # Returns a 2-element array `[q, r]`, where
+  #
+  #     q = (self/other).floor                  # Quotient
+  #     r = self % other                        # Remainder
+  #
+  # Of the Core and Standard Library classes, only Rational uses this
+  # implementation.
+  #
+  # Examples:
+  #
+  #     Rational(11, 1).divmod(4)               # => [2, (3/1)]
+  #     Rational(11, 1).divmod(-4)              # => [-3, (-1/1)]
+  #     Rational(-11, 1).divmod(4)              # => [-3, (1/1)]
+  #     Rational(-11, 1).divmod(-4)             # => [2, (-3/1)]
+  #
+  #     Rational(12, 1).divmod(4)               # => [3, (0/1)]
+  #     Rational(12, 1).divmod(-4)              # => [-3, (0/1)]
+  #     Rational(-12, 1).divmod(4)              # => [-3, (0/1)]
+  #     Rational(-12, 1).divmod(-4)             # => [3, (0/1)]
+  #
+  #     Rational(13, 1).divmod(4.0)             # => [3, 1.0]
+  #     Rational(13, 1).divmod(Rational(4, 11)) # => [35, (3/11)]
   #
   def divmod: (Numeric) -> [ Numeric, Numeric ]
 
-  # Returns `true` if `num` and `numeric` are the same type and have equal values.
-  #  Contrast this with Numeric#==, which performs type conversions.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - eql?(other) -> true or false
+  # -->
+  # Returns `true` if `self` and `other` are the same type and have equal values.
+  #
+  # Of the Core and Standard Library classes, only Integer, Rational, and Complex
+  # use this implementation.
+  #
+  # Examples:
   #
-  #     1 == 1.0        #=> true
-  #     1.eql?(1.0)     #=> false
-  #     1.0.eql?(1.0)   #=> true
+  #     1.eql?(1)              # => true
+  #     1.eql?(1.0)            # => false
+  #     1.eql?(Rational(1, 1)) # => false
+  #     1.eql?(Complex(1, 0))  # => false
+  #
+  # Method `eql?` is different from +==+ in that `eql?` requires matching types,
+  # while +==+ does not.
   #
   def eql?: (untyped) -> bool
 
-  # Returns float division.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - fdiv(other) -> float
+  # -->
+  # Returns the quotient `self/other` as a float, using method `/` in the derived
+  # class of `self`. (Numeric itself does not define method `/`.)
+  #
+  # Of the Core and Standard Library classes, only BigDecimal uses this
+  # implementation.
   #
   def fdiv: (Numeric) -> Numeric
 
+  # <!--
+  #   rdoc-file=numeric.rb
+  #   - num.finite?  ->  true or false
+  # -->
   # Returns `true` if `num` is a finite number, otherwise returns `false`.
   #
   def finite?: () -> bool
 
-  # Returns the largest number less than or equal to `num` with a precision of
-  # `ndigits` decimal digits (default: 0).
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - floor(digits = 0) -> integer or float
+  # -->
+  # Returns the largest number that is less than or equal to `self` with a
+  # precision of `digits` decimal digits.
   #
-  # Numeric implements this by converting its value to a Float and invoking
+  # Numeric implements this by converting `self` to a Float and invoking
   # Float#floor.
   #
   def floor: () -> Integer
            | (Integer digits) -> Numeric
 
-  # Returns the corresponding imaginary number. Not available for complex numbers.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - i -> complex
+  # -->
+  # Returns `Complex(0, self)`:
   #
-  #     -42.i  #=> (0-42i)
-  #     2.0.i  #=> (0+2.0i)
+  #     2.i              # => (0+2i)
+  #     -2.i             # => (0-2i)
+  #     2.0.i            # => (0+2.0i)
+  #     Rational(1, 2).i # => (0+(1/2)*i)
+  #     Complex(3, 4).i  # Raises NoMethodError.
   #
   def i: () -> Complex
 
+  # <!-- rdoc-file=complex.c -->
   # Returns zero.
   #
   def imag: () -> Numeric
 
+  # <!--
+  #   rdoc-file=complex.c
+  #   - num.imag       ->  0
+  #   - num.imaginary  ->  0
+  # -->
   # Returns zero.
   #
   def imaginary: () -> Numeric
 
+  # <!--
+  #   rdoc-file=numeric.rb
+  #   - num.infinite?  ->  -1, 1, or nil
+  # -->
   # Returns `nil`, -1, or 1 depending on whether the value is finite, `-Infinity`,
   # or `+Infinity`.
   #
   def infinite?: () -> Integer?
 
+  # <!--
+  #   rdoc-file=numeric.rb
+  #   - num.integer?  ->  true or false
+  # -->
   # Returns `true` if `num` is an Integer.
   #
   #     1.0.integer?   #=> false
@@ -262,165 +558,347 @@ class Numeric
   #
   def integer?: () -> bool
 
-  # Returns the absolute value of `num`.
+  # <!-- rdoc-file=numeric.c -->
+  # Returns the absolute value of `self`.
   #
-  #     12.abs         #=> 12
-  #     (-34.56).abs   #=> 34.56
-  #     -34.56.abs     #=> 34.56
+  #     12.abs        #=> 12
+  #     (-34.56).abs  #=> 34.56
+  #     -34.56.abs    #=> 34.56
   #
   # Numeric#magnitude is an alias for Numeric#abs.
   #
   alias magnitude abs
 
-  # `x.modulo(y)` means `x-y*(x/y).floor`.
+  # <!-- rdoc-file=numeric.c -->
+  # Returns `self` modulo `other` as a real number.
+  #
+  # Of the Core and Standard Library classes, only Rational uses this
+  # implementation.
   #
-  # Equivalent to `num.divmod(numeric)[1]`.
+  # For Rational `r` and real number `n`, these expressions are equivalent:
+  #
+  #     c % n
+  #     c-n*(c/n).floor
+  #     c.divmod(n)[1]
   #
   # See Numeric#divmod.
   #
+  # Examples:
+  #
+  #     r = Rational(1, 2)    # => (1/2)
+  #     r2 = Rational(2, 3)   # => (2/3)
+  #     r % r2                # => (1/2)
+  #     r % 2                 # => (1/2)
+  #     r % 2.0               # => 0.5
+  #
+  #     r = Rational(301,100) # => (301/100)
+  #     r2 = Rational(7,5)    # => (7/5)
+  #     r % r2                # => (21/100)
+  #     r % -r2               # => (-119/100)
+  #     (-r) % r2             # => (119/100)
+  #     (-r) %-r2             # => (-21/100)
+  #
+  # Numeric#modulo is an alias for Numeric#%.
+  #
   def modulo: (Numeric) -> Numeric
 
-  # Returns `true` if `num` is less than 0.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - negative? -> true or false
+  # -->
+  # Returns `true` if `self` is less than 0, `false` otherwise.
   #
   def negative?: () -> bool
 
-  # Returns `self` if `num` is not zero, `nil` otherwise.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - nonzero?  ->  self or nil
+  # -->
+  # Returns `self` if `self` is not a zero value, `nil` otherwise; uses method
+  # `zero?` for the evaluation.
+  #
+  # The returned `self` allows the method to be chained:
   #
-  # This behavior is useful when chaining comparisons:
+  #     a = %w[z Bb bB bb BB a aA Aa AA A]
+  #     a.sort {|a, b| (a.downcase <=> b.downcase).nonzero? || a <=> b }
+  #     # => ["A", "a", "AA", "Aa", "aA", "BB", "Bb", "bB", "bb", "z"]
   #
-  #     a = %w( z Bb bB bb BB a aA Aa AA A )
-  #     b = a.sort {|a,b| (a.downcase <=> b.downcase).nonzero? || a <=> b }
-  #     b   #=> ["A", "a", "AA", "Aa", "aA", "BB", "Bb", "bB", "bb", "z"]
+  # Of the Core and Standard Library classes, Integer, Float, Rational, and
+  # Complex use this implementation.
   #
   def nonzero?: () -> self?
 
+  # <!--
+  #   rdoc-file=rational.c
+  #   - num.numerator  ->  integer
+  # -->
   # Returns the numerator.
   #
   def numerator: () -> Numeric
 
+  # <!-- rdoc-file=complex.c -->
   # Returns 0 if the value is positive, pi otherwise.
   #
   alias phase angle
 
+  # <!--
+  #   rdoc-file=complex.c
+  #   - num.polar  ->  array
+  # -->
   # Returns an array; [num.abs, num.arg].
   #
   def polar: () -> [ Numeric, Numeric ]
 
-  # Returns `true` if `num` is greater than 0.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - positive? -> true or false
+  # -->
+  # Returns `true` if `self` is greater than 0, `false` otherwise.
   #
   def positive?: () -> bool
 
+  # <!--
+  #   rdoc-file=rational.c
+  #   - num.quo(int_or_rat)   ->  rat
+  #   - num.quo(flo)          ->  flo
+  # -->
   # Returns the most exact division (rational for integers, float for floats).
   #
   def quo: (Numeric) -> Numeric
 
+  # <!--
+  #   rdoc-file=complex.c
+  #   - num.real  ->  self
+  # -->
   # Returns self.
   #
   def real: () -> Numeric
 
+  # <!--
+  #   rdoc-file=numeric.rb
+  #   - num.real?  ->  true or false
+  # -->
   # Returns `true` if `num` is a real number (i.e. not Complex).
   #
   def real?: () -> bool
 
+  # <!-- rdoc-file=complex.c -->
   # Returns an array; [num, 0].
   #
   def rect: () -> [ Numeric, Numeric ]
 
+  # <!--
+  #   rdoc-file=complex.c
+  #   - num.rect  ->  array
+  #   - num.rectangular  ->  array
+  # -->
   # Returns an array; [num, 0].
   #
   alias rectangular rect
 
-  # `x.remainder(y)` means `x-y*(x/y).truncate`.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - remainder(other) -> real_number
+  # -->
+  # Returns the remainder after dividing `self` by `other`.
   #
-  # See Numeric#divmod.
+  # Of the Core and Standard Library classes, only Float and Rational use this
+  # implementation.
+  #
+  # Examples:
+  #
+  #     11.0.remainder(4)              # => 3.0
+  #     11.0.remainder(-4)             # => 3.0
+  #     -11.0.remainder(4)             # => -3.0
+  #     -11.0.remainder(-4)            # => -3.0
+  #
+  #     12.0.remainder(4)              # => 0.0
+  #     12.0.remainder(-4)             # => 0.0
+  #     -12.0.remainder(4)             # => -0.0
+  #     -12.0.remainder(-4)            # => -0.0
+  #
+  #     13.0.remainder(4.0)            # => 1.0
+  #     13.0.remainder(Rational(4, 1)) # => 1.0
+  #
+  #     Rational(13, 1).remainder(4)   # => (1/1)
+  #     Rational(13, 1).remainder(-4)  # => (1/1)
+  #     Rational(-13, 1).remainder(4)  # => (-1/1)
+  #     Rational(-13, 1).remainder(-4) # => (-1/1)
   #
   def remainder: (Numeric) -> Numeric
 
-  # Returns `num` rounded to the nearest value with a precision of `ndigits`
-  # decimal digits (default: 0).
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - round(digits = 0) -> integer or float
+  # -->
+  # Returns `self` rounded to the nearest value with a precision of `digits`
+  # decimal digits.
   #
-  # Numeric implements this by converting its value to a Float and invoking
+  # Numeric implements this by converting `self` to a Float and invoking
   # Float#round.
   #
   def round: () -> Integer
            | (Integer digits) -> Numeric
 
-  # Invokes the given block with the sequence of numbers starting at `num`,
-  # incremented by `step` (defaulted to `1`) on each call.
-  #
-  # The loop finishes when the value to be passed to the block is greater than
-  # `limit` (if `step` is positive) or less than `limit` (if `step` is negative),
-  # where `limit` is defaulted to infinity.
-  #
-  # In the recommended keyword argument style, either or both of `step` and
-  # `limit` (default infinity) can be omitted.  In the fixed position argument
-  # style, zero as a step (i.e. `num.step(limit, 0)`) is not allowed for
-  # historical compatibility reasons.
-  #
-  # If all the arguments are integers, the loop operates using an integer counter.
-  #
-  # If any of the arguments are floating point numbers, all are converted to
-  # floats, and the loop is executed *floor(n + n*Float::EPSILON) + 1* times,
-  # where *n = (limit - num)/step*.
-  #
-  # Otherwise, the loop starts at `num`, uses either the less-than (`<`) or
-  # greater-than (`>`) operator to compare the counter against `limit`, and
-  # increments itself using the `+` operator.
-  #
-  # If no block is given, an Enumerator is returned instead. Especially, the
-  # enumerator is an Enumerator::ArithmeticSequence if both `limit` and `step` are
-  # kind of Numeric or `nil`.
-  #
-  # For example:
-  #
-  #     p 1.step.take(4)
-  #     p 10.step(by: -1).take(4)
-  #     3.step(to: 5) {|i| print i, " " }
-  #     1.step(10, 2) {|i| print i, " " }
-  #     Math::E.step(to: Math::PI, by: 0.2) {|f| print f, " " }
-  #
-  # Will produce:
-  #
-  #     [1, 2, 3, 4]
-  #     [10, 9, 8, 7]
-  #     3 4 5
-  #     1 3 5 7 9
-  #     2.718281828459045 2.9182818284590453 3.118281828459045
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - step(to = nil, by = 1) {|n| ... } ->  self
+  #   - step(to = nil, by = 1)            ->  enumerator
+  #   - step(to = nil, by: 1) {|n| ... }  ->  self
+  #   - step(to = nil, by: 1)             ->  enumerator
+  #   - step(by: 1, to: ) {|n| ... }      ->  self
+  #   - step(by: 1, to: )                 ->  enumerator
+  #   - step(by: , to: nil) {|n| ... }    ->  self
+  #   - step(by: , to: nil)               ->  enumerator
+  # -->
+  # Generates a sequence of numbers; with a block given, traverses the sequence.
+  #
+  #     Of the Core and Standard Library classes,
+  #     Integer, Float, and Rational use this implementation.
+  #
+  #     A quick example:
+  #
+  #       squares = []
+  #       1.step(by: 2, to: 10) {|i| squares.push(i*i) }
+  #       squares # => [1, 9, 25, 49, 81]
+  #
+  #     The generated sequence:
+  #
+  #     - Begins with +self+.
+  #     - Continues at intervals of +step+ (which may not be zero).
+  #     - Ends with the last number that is within or equal to +limit+;
+  #       that is, less than or equal to +limit+ if +step+ is positive,
+  #       greater than or equal to +limit+ if +step+ is negative.
+  #       If +limit+ is not given, the sequence is of infinite length.
+  #
+  #     If a block is given, calls the block with each number in the sequence;
+  #     returns +self+.  If no block is given, returns an Enumerator::ArithmeticSequence.
+  #
+  #     <b>Keyword Arguments</b>
+  #
+  #     With keyword arguments +by+ and +to+,
+  #     their values (or defaults) determine the step and limit:
+  #
+  #       # Both keywords given.
+  #       squares = []
+  #       4.step(by: 2, to: 10) {|i| squares.push(i*i) }    # => 4
+  #       squares # => [16, 36, 64, 100]
+  #       cubes = []
+  #       3.step(by: -1.5, to: -3) {|i| cubes.push(i*i*i) } # => 3
+  #       cubes   # => [27.0, 3.375, 0.0, -3.375, -27.0]
+  #       squares = []
+  #       1.2.step(by: 0.2, to: 2.0) {|f| squares.push(f*f) }
+  #       squares # => [1.44, 1.9599999999999997, 2.5600000000000005, 3.24, 4.0]
+  #
+  #       squares = []
+  #       Rational(6/5).step(by: 0.2, to: 2.0) {|r| squares.push(r*r) }
+  #       squares # => [1.0, 1.44, 1.9599999999999997, 2.5600000000000005, 3.24, 4.0]
+  #
+  #       # Only keyword to given.
+  #       squares = []
+  #       4.step(to: 10) {|i| squares.push(i*i) }           # => 4
+  #       squares # => [16, 25, 36, 49, 64, 81, 100]
+  #       # Only by given.
+  #
+  #       # Only keyword by given
+  #       squares = []
+  #       4.step(by:2) {|i| squares.push(i*i); break if i > 10 }
+  #       squares # => [16, 36, 64, 100, 144]
+  #
+  #       # No block given.
+  #       e = 3.step(by: -1.5, to: -3) # => (3.step(by: -1.5, to: -3))
+  #       e.class                      # => Enumerator::ArithmeticSequence
+  #
+  #     <b>Positional Arguments</b>
+  #
+  #     With optional positional arguments +limit+ and +step+,
+  #     their values (or defaults) determine the step and limit:
+  #
+  #       squares = []
+  #       4.step(10, 2) {|i| squares.push(i*i) }    # => 4
+  #       squares # => [16, 36, 64, 100]
+  #       squares = []
+  #       4.step(10) {|i| squares.push(i*i) }
+  #       squares # => [16, 25, 36, 49, 64, 81, 100]
+  #       squares = []
+  #       4.step {|i| squares.push(i*i); break if i > 10 }  # => nil
+  #       squares # => [16, 25, 36, 49, 64, 81, 100, 121]
+  #
+  # **Implementation Notes**
+  #
+  #     If all the arguments are integers, the loop operates using an integer
+  #     counter.
+  #
+  #     If any of the arguments are floating point numbers, all are converted
+  #     to floats, and the loop is executed
+  #     <i>floor(n + n*Float::EPSILON) + 1</i> times,
+  #     where <i>n = (limit - self)/step</i>.
   #
   def step: (?Numeric limit, ?Numeric step) { (Numeric) -> void } -> self
           | (?Numeric limit, ?Numeric step) -> Enumerator[Numeric, self]
           | (?by: Numeric, ?to: Numeric) { (Numeric) -> void } -> self
           | (?by: Numeric, ?to: Numeric) -> Enumerator[Numeric, self]
 
+  # <!--
+  #   rdoc-file=complex.c
+  #   - num.to_c  ->  complex
+  # -->
   # Returns the value as a complex.
   #
   def to_c: () -> Complex
 
-  # Invokes the child class's `to_i` method to convert `num` to an integer.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - to_int -> integer
+  # -->
+  # Returns `self` as an integer; converts using method `to_i` in the derived
+  # class.
+  #
+  # Of the Core and Standard Library classes, only Rational and Complex use this
+  # implementation.
   #
-  #     1.0.class          #=> Float
-  #     1.0.to_int.class   #=> Integer
-  #     1.0.to_i.class     #=> Integer
+  # Examples:
+  #
+  #     Rational(1, 2).to_int # => 0
+  #     Rational(2, 1).to_int # => 2
+  #     Complex(2, 0).to_int  # => 2
+  #     Complex(2, 1)         # Raises RangeError (non-zero imaginary part)
   #
   def to_int: () -> Integer
 
-  # Returns `num` truncated (toward zero) to a precision of `ndigits` decimal
-  # digits (default: 0).
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - truncate(digits = 0) -> integer or float
+  # -->
+  # Returns `self` truncated (toward zero) to a precision of `digits` decimal
+  # digits.
   #
-  # Numeric implements this by converting its value to a Float and invoking
+  # Numeric implements this by converting `self` to a Float and invoking
   # Float#truncate.
   #
   def truncate: () -> Integer
               | (Integer ndigits) -> (Integer | Numeric)
 
-  # Returns `true` if `num` has a zero value.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - zero? -> true or false
+  # -->
+  # Returns `true` if `zero` has a zero value, `false` otherwise.
+  #
+  # Of the Core and Standard Library classes, only Rational and Complex use this
+  # implementation.
   #
   def zero?: () -> bool
 
-  # Returns +self+.
+  # <!--
+  #   rdoc-file=numeric.c
+  #   - clone(freeze: true) -> self
+  # -->
+  # Returns `self`.
   #
-  # Raises an exception if the value for +freeze+ is neither +true+ nor +nil+.
+  # Raises an exception if the value for `freeze` is neither `true` nor `nil`.
   #
   # Related: Numeric#dup.
+  #
   def clone: (?freeze: true?) -> self
 end