rbs 4.0.0.dev.4 → 4.1.0.pre.2

data/core/rbs/unnamed/random.rbs

@@ -31,12 +31,14 @@ module RBS
       #     prng.rand(100)       # => 42
       #
       # When `max` is a Float, `rand` returns a random floating point number between
-      # 0.0 and `max`, including 0.0 and excluding `max`.
+      # 0.0 and `max`, including 0.0 and excluding `max`. Note that it behaves
+      # differently from Kernel.rand.
       #
-      #     prng.rand(1.5)       # => 1.4600282860034115
+      #     prng.rand(1.5)  # => 1.4600282860034115
+      #     rand(1.5)       # => 0
       #
       # When `range` is a Range, `rand` returns a random number where
-      # `range.member?(number) == true`.
+      # <code>range.member?(number) == true</code>.
       #
       #     prng.rand(5..9)      # => one of [5, 6, 7, 8, 9]
       #     prng.rand(5...9)     # => one of [5, 6, 7, 8]
@@ -44,7 +46,8 @@ module RBS
       #     prng.rand(5.0...9.0) # => between 5.0 and 9.0, excluding 9.0
       #
       # Both the beginning and ending values of the range must respond to subtract
-      # (`-`) and add (`+`)methods, or rand will raise an ArgumentError.
+      # (<code>-</code>) and add (<code>+</code>)methods, or rand will raise an
+      # ArgumentError.
       #
       %a{annotate:rdoc:copy:Random#rand}
       def rand: (?0) -> Float
@@ -85,9 +88,10 @@ module RBS
     # <!-- rdoc-file=lib/random/formatter.rb -->
     # ## Random number formatter.
     #
-    # Formats generated random numbers in many manners. When `'random/formatter'` is
-    # required, several methods are added to empty core module `Random::Formatter`,
-    # making them available as Random's instance and module methods.
+    # Formats generated random numbers in many manners. When
+    # <code>'random/formatter'</code> is required, several methods are added to
+    # empty core module <code>Random::Formatter</code>, making them available as
+    # Random's instance and module methods.
     #
     # Standard library SecureRandom is also extended with the module, and the
     # methods described below are available as a module methods in it.
@@ -146,56 +150,6 @@ module RBS
     #
     %a{annotate:rdoc:copy:Random::Formatter}
     module Random_Formatter
-      # <!--
-      #   rdoc-file=lib/random/formatter.rb
-      #   - base64(n=nil)
-      # -->
-      # Generate a random base64 string.
-      #
-      # The argument *n* specifies the length, in bytes, of the random number to be
-      # generated. The length of the result string is about 4/3 of *n*.
-      #
-      # If *n* is not specified or is nil, 16 is assumed. It may be larger in the
-      # future.
-      #
-      # The result may contain A-Z, a-z, 0-9, "+", "/" and "=".
-      #
-      #     require 'random/formatter'
-      #
-      #     Random.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
-      #     # or
-      #     prng = Random.new
-      #     prng.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
-      #
-      # See RFC 3548 for the definition of base64.
-      #
-      %a{annotate:rdoc:copy:Random::Formatter#base64}
-      def base64: (?Integer? n) -> String
-
-      # <!--
-      #   rdoc-file=lib/random/formatter.rb
-      #   - hex(n=nil)
-      # -->
-      # Generate a random hexadecimal string.
-      #
-      # The argument *n* specifies the length, in bytes, of the random number to be
-      # generated. The length of the resulting hexadecimal string is twice of *n*.
-      #
-      # If *n* is not specified or is nil, 16 is assumed. It may be larger in the
-      # future.
-      #
-      # The result may contain 0-9 and a-f.
-      #
-      #     require 'random/formatter'
-      #
-      #     Random.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
-      #     # or
-      #     prng = Random.new
-      #     prng.hex #=> "91dc3bfb4de5b11d029d376634589b61"
-      #
-      %a{annotate:rdoc:copy:Random::Formatter#hex}
-      def hex: (?Integer? n) -> String
-
       # <!-- rdoc-file=random.c -->
       # Generates formatted random number from raw random bytes. See Random#rand.
       #
@@ -208,9 +162,6 @@ module RBS
               | (::Range[Integer] n) -> Integer
               | (::Range[Numeric] n) -> Numeric
 
-      %a{annotate:rdoc:copy:Random::Formatter#random_byte}
-      def random_bytes: (?Integer? n) -> String
-
       # <!--
       #   rdoc-file=random.c
       #   - prng.random_number        -> float
@@ -230,64 +181,6 @@ module RBS
                        | (?::Range[Float]? n) -> Float
                        | (?::Range[Integer]? n) -> Integer
                        | (?::Range[Numeric]? n) -> Numeric
-
-      # <!--
-      #   rdoc-file=lib/random/formatter.rb
-      #   - urlsafe_base64(n=nil, padding=false)
-      # -->
-      # Generate a random URL-safe base64 string.
-      #
-      # The argument *n* specifies the length, in bytes, of the random number to be
-      # generated. The length of the result string is about 4/3 of *n*.
-      #
-      # If *n* is not specified or is nil, 16 is assumed. It may be larger in the
-      # future.
-      #
-      # The boolean argument *padding* specifies the padding. If it is false or nil,
-      # padding is not generated. Otherwise padding is generated. By default, padding
-      # is not generated because "=" may be used as a URL delimiter.
-      #
-      # The result may contain A-Z, a-z, 0-9, "-" and "_". "=" is also used if
-      # *padding* is true.
-      #
-      #     require 'random/formatter'
-      #
-      #     Random.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
-      #     # or
-      #     prng = Random.new
-      #     prng.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
-      #
-      #     prng.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
-      #     prng.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="
-      #
-      # See RFC 3548 for the definition of URL-safe base64.
-      #
-      %a{annotate:rdoc:copy:Random::Formatter#urlsafe_base64}
-      def urlsafe_base64: (?Integer? n, ?boolish padding) -> String
-
-      # <!--
-      #   rdoc-file=lib/random/formatter.rb
-      #   - uuid()
-      # -->
-      # Generate a random v4 UUID (Universally Unique IDentifier).
-      #
-      #     require 'random/formatter'
-      #
-      #     Random.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
-      #     Random.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
-      #     # or
-      #     prng = Random.new
-      #     prng.uuid #=> "62936e70-1815-439b-bf89-8492855a7e6b"
-      #
-      # The version 4 UUID is purely random (except the version). It doesn't contain
-      # meaningful information such as MAC addresses, timestamps, etc.
-      #
-      # The result contains 122 random bits (15.25 random bytes).
-      #
-      # See [RFC9562](https://www.rfc-editor.org/rfc/rfc9562) for details of UUIDv4.
-      #
-      %a{annotate:rdoc:copy:Random::Formatter#uuid}
-      def uuid: () -> String
     end
   end
 end