rbs 2.0.0 → 2.1.0

data/core/random.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=random.c -->
 # Random provides an interface to Ruby's pseudo-random number generator, or
 # PRNG.  The PRNG produces a deterministic sequence of bits which approximate
 # true randomness. The sequence may be represented by integers, floats, or
@@ -8,19 +9,24 @@
 #
 # The class method Random.rand provides the base functionality of Kernel.rand
 # along with better handling of floating point values. These are both interfaces
-# to Random::DEFAULT, the Ruby system PRNG.
+# to the Ruby system PRNG.
 #
-# Random.new will create a new PRNG with a state independent of Random::DEFAULT,
-# allowing multiple generators with different seed values or sequence positions
-# to exist simultaneously. Random objects can be marshaled, allowing sequences
-# to be saved and resumed.
+# Random.new will create a new PRNG with a state independent of the Ruby system
+# PRNG, allowing multiple generators with different seed values or sequence
+# positions to exist simultaneously. Random objects can be marshaled, allowing
+# sequences to be saved and resumed.
 #
 # PRNGs are currently implemented as a modified Mersenne Twister with a period
-# of 2**19937-1.
+# of 2**19937-1.  As this algorithm is *not* for cryptographical use, you must
+# use SecureRandom for security purpose, instead of this PRNG.
 #
 class Random < Object
   include Random::Formatter
 
+  # <!--
+  #   rdoc-file=random.c
+  #   - prng1 == prng2 -> true or false
+  # -->
   # Returns true if the two generators have the same internal state, otherwise
   # false.  Equivalent generators will return the same sequence of pseudo-random
   # numbers.  Two generators will generally have the same state only if they were
@@ -43,6 +49,10 @@ class Random < Object
   #
   def ==: (untyped arg0) -> bool
 
+  # <!--
+  #   rdoc-file=random.c
+  #   - prng.bytes(size) -> string
+  # -->
   # Returns a random binary string containing `size` bytes.
   #
   #     random_string = Random.new.bytes(10) # => "\xD7:R\xAB?\x83\xCE\xFAkO"
@@ -50,6 +60,10 @@ class Random < Object
   #
   def bytes: (Integer size) -> String
 
+  # <!--
+  #   rdoc-file=random.c
+  #   - Random.new(seed = Random.new_seed) -> prng
+  # -->
   # Creates a new PRNG using `seed` to set the initial state. If `seed` is
   # omitted, the generator is initialized with Random.new_seed.
   #
@@ -57,6 +71,12 @@ class Random < Object
   #
   def initialize: (?Integer seed) -> void
 
+  # <!--
+  #   rdoc-file=random.c
+  #   - prng.rand -> float
+  #   - prng.rand(max) -> number
+  #   - prng.rand(range) -> number
+  # -->
   # When `max` is an Integer, `rand` returns a random integer greater than or
   # equal to zero and less than `max`. Unlike Kernel.rand, when `max` is a
   # negative integer or zero, `rand` raises an ArgumentError.
@@ -69,8 +89,8 @@ class Random < Object
   #
   #     prng.rand(1.5)       # => 1.4600282860034115
   #
-  # When `max` is a Range, `rand` returns a random number where
-  # range.member?(number) == true.
+  # When `range` is a Range, `rand` returns a random number where
+  # `range.member?(number) == true`.
   #
   #     prng.rand(5..9)      # => one of [5, 6, 7, 8, 9]
   #     prng.rand(5...9)     # => one of [5, 6, 7, 8]
@@ -84,6 +104,10 @@ class Random < Object
           | (Integer | ::Range[Integer] max) -> Integer
           | (Float | ::Range[Float] max) -> Float
 
+  # <!--
+  #   rdoc-file=random.c
+  #   - prng.seed -> integer
+  # -->
   # Returns the seed value used to initialize the generator. This may be used to
   # initialize another generator with the same state at a later time, causing it
   # to produce the same sequence of numbers.
@@ -97,6 +121,10 @@ class Random < Object
   #
   def seed: () -> Integer
 
+  # <!--
+  #   rdoc-file=random.c
+  #   - Random.new_seed -> integer
+  # -->
   # Returns an arbitrary seed value. This is used by Random.new when no seed value
   # is specified as an argument.
   #
@@ -104,14 +132,26 @@ class Random < Object
   #
   def self.new_seed: () -> Integer
 
-  # Alias of Random::DEFAULT.rand.
+  # <!--
+  #   rdoc-file=random.c
+  #   - Random.rand -> float
+  #   - Random.rand(max) -> number
+  #   - Random.rand(range) -> number
+  # -->
+  # Returns a random number using the Ruby system PRNG.
+  #
+  # See also Random#rand.
   #
   def self.rand: () -> Float
                | (Integer | ::Range[Integer] max) -> Integer
                | (Float | ::Range[Float] max) -> Float
 
-  # Seeds the system pseudo-random number generator, Random::DEFAULT, with
-  # `number`.  The previous seed value is returned.
+  # <!--
+  #   rdoc-file=random.c
+  #   - srand(number = Random.new_seed) -> old_seed
+  # -->
+  # Seeds the system pseudo-random number generator, with `number`. The previous
+  # seed value is returned.
   #
   # If `number` is omitted, seeds the generator using a source of entropy provided
   # by the operating system, if available (/dev/urandom on Unix systems or the RSA
@@ -131,16 +171,60 @@ class Random < Object
   def self.srand: (?Integer number) -> Integer
 end
 
-# The default Pseudorandom number generator.  Used by class methods of Random.
-#
-#
 Random::DEFAULT: Random
 
-# Format raw random number as Random does
+# <!-- rdoc-file=lib/random/formatter.rb -->
+# ## Random number formatter.
+#
+# Formats generated random numbers in many manners.
+#
+# ### Examples
+#
+# Generate random hexadecimal strings:
+#
+#     require 'random/formatter'
+#
+#     prng.hex(10) #=> "52750b30ffbc7de3b362"
+#     prng.hex(10) #=> "92b15d6c8dc4beb5f559"
+#     prng.hex(13) #=> "39b290146bea6ce975c37cfc23"
+#
+# Generate random base64 strings:
+#
+#     prng.base64(10) #=> "EcmTPZwWRAozdA=="
+#     prng.base64(10) #=> "KO1nIU+p9DKxGg=="
+#     prng.base64(12) #=> "7kJSM/MzBJI+75j8"
+#
+# Generate random binary strings:
+#
+#     prng.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
+#     prng.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
 #
+# Generate alphanumeric strings:
+#
+#     prng.alphanumeric(10) #=> "S8baxMJnPl"
+#     prng.alphanumeric(10) #=> "aOxAg8BAJe"
+#
+# Generate UUIDs:
+#
+#     prng.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
+#     prng.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
+#
+# <!-- rdoc-file=random.c -->
+# Generate a random number in the given range as Random does
+#
+#     prng.random_number       #=> 0.5816771641321361
+#     prng.random_number(1000) #=> 485
+#     prng.random_number(1..6) #=> 3
+#     prng.rand                #=> 0.5816771641321361
+#     prng.rand(1000)          #=> 485
+#     prng.rand(1..6)          #=> 3
 #
 module Random::Formatter
-  # SecureRandom.base64 generates a random base64 string.
+  # <!--
+  #   rdoc-file=lib/random/formatter.rb
+  #   - base64(n=nil)
+  # -->
+  # Random::Formatter#base64 generates 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*.
@@ -150,19 +234,20 @@ module Random::Formatter
   #
   # The result may contain A-Z, a-z, 0-9, "+", "/" and "=".
   #
-  #     require 'securerandom'
-  #
-  #     SecureRandom.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
-  #     SecureRandom.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
+  #     require 'random/formatter'
   #
-  # If a secure random number generator is not available, `NotImplementedError` is
-  # raised.
+  #     prng.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
+  #     prng.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
   #
   # See RFC 3548 for the definition of base64.
   #
   def base64: (?Integer? n) -> String
 
-  # SecureRandom.hex generates a random hexadecimal string.
+  # <!--
+  #   rdoc-file=lib/random/formatter.rb
+  #   - hex(n=nil)
+  # -->
+  # Random::Formatter#hex generates 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*.
@@ -172,16 +257,14 @@ module Random::Formatter
   #
   # The result may contain 0-9 and a-f.
   #
-  #     require 'securerandom'
+  #     require 'random/formatter'
   #
-  #     SecureRandom.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
-  #     SecureRandom.hex #=> "91dc3bfb4de5b11d029d376634589b61"
-  #
-  # If a secure random number generator is not available, `NotImplementedError` is
-  # raised.
+  #     prng.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
+  #     prng.hex #=> "91dc3bfb4de5b11d029d376634589b61"
   #
   def hex: (?Integer? n) -> String
 
+  # <!-- rdoc-file=random.c -->
   # Generates formatted random number from raw random bytes. See Random#rand.
   #
   def rand: () -> Float
@@ -192,7 +275,11 @@ module Random::Formatter
           | (?::Range[Integer]? n) -> Integer
           | (?::Range[Numeric]? n) -> Numeric
 
-  # SecureRandom.random_bytes generates a random binary string.
+  # <!--
+  #   rdoc-file=lib/random/formatter.rb
+  #   - random_bytes(n=nil)
+  # -->
+  # Random::Formatter#random_bytes generates a random binary string.
   #
   # The argument *n* specifies the length of the result string.
   #
@@ -200,16 +287,22 @@ module Random::Formatter
   #
   # The result may contain any byte: "x00" - "xff".
   #
-  #     require 'securerandom'
-  #
-  #     SecureRandom.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
-  #     SecureRandom.random_bytes #=> "m\xDC\xFC/\a\x00Uf\xB2\xB2P\xBD\xFF6S\x97"
+  #     require 'random/formatter'
   #
-  # If a secure random number generator is not available, `NotImplementedError` is
-  # raised.
+  #     prng.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
+  #     prng.random_bytes #=> "m\xDC\xFC/\a\x00Uf\xB2\xB2P\xBD\xFF6S\x97"
   #
   def random_bytes: (?Integer? n) -> String
 
+  # <!--
+  #   rdoc-file=random.c
+  #   - prng.random_number        -> float
+  #   - prng.random_number(max)   -> number
+  #   - prng.random_number(range) -> number
+  #   - prng.rand                 -> float
+  #   - prng.rand(max)            -> number
+  #   - prng.rand(range)          -> number
+  # -->
   # Generates formatted random number from raw random bytes. See Random#rand.
   #
   def random_number: () -> Float
@@ -220,7 +313,11 @@ module Random::Formatter
                    | (?::Range[Integer]? n) -> Integer
                    | (?::Range[Numeric]? n) -> Numeric
 
-  # SecureRandom.urlsafe_base64 generates a random URL-safe base64 string.
+  # <!--
+  #   rdoc-file=lib/random/formatter.rb
+  #   - urlsafe_base64(n=nil, padding=false)
+  # -->
+  # Random::Formatter#urlsafe_base64 generates 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*.
@@ -235,28 +332,30 @@ module Random::Formatter
   # The result may contain A-Z, a-z, 0-9, "-" and "_". "=" is also used if
   # *padding* is true.
   #
-  #     require 'securerandom'
-  #
-  #     SecureRandom.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
-  #     SecureRandom.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
+  #     require 'random/formatter'
   #
-  #     SecureRandom.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
-  #     SecureRandom.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="
+  #     prng.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
+  #     prng.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
   #
-  # If a secure random number generator is not available, `NotImplementedError` is
-  # raised.
+  #     prng.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
+  #     prng.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="
   #
   # See RFC 3548 for the definition of URL-safe base64.
   #
   def urlsafe_base64: (?Integer? n, ?boolish padding) -> String
 
-  # SecureRandom.uuid generates a random v4 UUID (Universally Unique IDentifier).
-  #
-  #     require 'securerandom'
-  #
-  #     SecureRandom.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
-  #     SecureRandom.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
-  #     SecureRandom.uuid #=> "62936e70-1815-439b-bf89-8492855a7e6b"
+  # <!--
+  #   rdoc-file=lib/random/formatter.rb
+  #   - uuid()
+  # -->
+  # Random::Formatter#uuid generates a random v4 UUID (Universally Unique
+  # IDentifier).
+  #
+  #     require 'random/formatter'
+  #
+  #     prng.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
+  #     prng.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
+  #     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.