rbs 3.10.0.pre.2 → 3.10.1

data/stdlib/bigdecimal-math/0/big_math.rbs

@@ -35,6 +35,46 @@ module BigMath
   #
   def self?.PI: (Numeric prec) -> BigDecimal
 
+  # Computes the arccosine of `decimal` to the specified number of digits of
+  # precision, `numeric`.
+  #
+  # If `decimal` is NaN, returns NaN.
+  #
+  #     BigMath.acos(BigDecimal('0.5'), 32).to_s
+  #     #=> "0.10471975511965977461542144610932e1"
+  #
+  def self?.acos: (BigDecimal, Numeric) -> BigDecimal
+
+  # Computes the inverse hyperbolic cosine of `decimal` to the specified number of
+  # digits of precision, `numeric`.
+  #
+  # If `decimal` is NaN, returns NaN.
+  #
+  #     BigMath.acosh(BigDecimal('2'), 32).to_s
+  #     #=> "0.1316957896924816708625046347308e1"
+  #
+  def self?.acosh: (BigDecimal, Numeric) -> BigDecimal
+
+  # Computes the arcsine of `decimal` to the specified number of digits of
+  # precision, `numeric`.
+  #
+  # If `decimal` is NaN, returns NaN.
+  #
+  #     BigMath.asin(BigDecimal('0.5'), 32).to_s
+  #     #=> "0.52359877559829887307710723054658e0"
+  #
+  def self?.asin: (BigDecimal, Numeric) -> BigDecimal
+
+  # Computes the inverse hyperbolic sine of `decimal` to the specified number of
+  # digits of precision, `numeric`.
+  #
+  # If `decimal` is NaN, returns NaN.
+  #
+  #     BigMath.asinh(BigDecimal('1'), 32).to_s
+  #     #=> "0.88137358701954302523260932497979e0"
+  #
+  def self?.asinh: (BigDecimal, Numeric) -> BigDecimal
+
   # <!--
   #   rdoc-file=ext/bigdecimal/lib/bigdecimal/math.rb
   #   - atan(decimal, numeric) -> BigDecimal
@@ -49,6 +89,32 @@ module BigMath
   #
   def self?.atan: (BigDecimal x, Numeric prec) -> BigDecimal
 
+  # Computes the arctangent of y and x to the specified number of digits of
+  # precision, `numeric`.
+  #
+  #     BigMath.atan2(BigDecimal('-1'), BigDecimal('1'), 32).to_s
+  #     #=> "-0.78539816339744830961566084581988e0"
+  #
+  def self?.atan2: (BigDecimal, BigDecimal, Numeric) -> BigDecimal
+
+  # Computes the inverse hyperbolic tangent of `decimal` to the specified number
+  # of digits of precision, `numeric`.
+  #
+  # If `decimal` is NaN, returns NaN.
+  #
+  #     BigMath.atanh(BigDecimal('0.5'), 32).to_s
+  #     #=> "0.54930614433405484569762261846126e0"
+  #
+  def self?.atanh: (BigDecimal, Numeric) -> BigDecimal
+
+  # Computes the cube root of `decimal` to the specified number of digits of
+  # precision, `numeric`.
+  #
+  #     BigMath.cbrt(BigDecimal('2'), 32).to_s
+  #     #=> "0.12599210498948731647672106072782e1"
+  #
+  def self?.cbrt: (BigDecimal, Numeric) -> BigDecimal
+
   # <!--
   #   rdoc-file=ext/bigdecimal/lib/bigdecimal/math.rb
   #   - cos(decimal, numeric) -> BigDecimal
@@ -63,10 +129,36 @@ module BigMath
   #
   def self?.cos: (BigDecimal x, Numeric prec) -> BigDecimal
 
-  # <!--
-  #   rdoc-file=ext/bigdecimal/bigdecimal.c
-  #   - BigMath.exp(decimal, numeric)    -> BigDecimal
-  # -->
+  # Computes the hyperbolic cosine of `decimal` to the specified number of digits
+  # of precision, `numeric`.
+  #
+  # If `decimal` is NaN, returns NaN.
+  #
+  #     BigMath.cosh(BigDecimal('1'), 32).to_s
+  #     #=> "0.15430806348152437784779056207571e1"
+  #
+  def self?.cosh: (BigDecimal, Numeric) -> BigDecimal
+
+  # Computes the error function of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.erf(BigDecimal('1'), 32).to_s
+  #   #=> "0.84270079294971486934122063508261e0"
+  #
+  def self?.erf: (BigDecimal, Numeric) -> BigDecimal
+
+  # Computes the complementary error function of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.erfc(BigDecimal('10'), 32).to_s
+  #   #=> "0.20884875837625447570007862949578e-44"
+  #
+  def self?.erfc: (BigDecimal, Numeric) -> BigDecimal
+
   # Computes the value of e (the base of natural logarithms) raised to the power
   # of `decimal`, to the specified number of digits of precision.
   #
@@ -76,10 +168,45 @@ module BigMath
   #
   def self?.exp: (BigDecimal, Numeric prec) -> BigDecimal
 
-  # <!--
-  #   rdoc-file=ext/bigdecimal/bigdecimal.c
-  #   - BigMath.log(decimal, numeric)    -> BigDecimal
-  # -->
+  # Decomposes +x+ into a normalized fraction and an integral power of ten.
+  #
+  #   BigMath.frexp(BigDecimal(123.456))
+  #   #=> [0.123456e0, 3]
+  #
+  def self?.frexp: (BigDecimal) -> [ BigDecimal, Integer ]
+
+  # Computes the gamma function of +decimal+ to the specified number of
+  # digits of precision, +numeric+.
+  #
+  #   BigMath.gamma(BigDecimal('0.5'), 32).to_s
+  #   #=> "0.17724538509055160272981674833411e1"
+  #
+  def self?.gamma: (BigDecimal, Numeric) -> BigDecimal
+
+  # Returns sqrt(x**2 + y**2) to the specified number of digits of precision,
+  # `numeric`.
+  #
+  #     BigMath.hypot(BigDecimal('1'), BigDecimal('2'), 32).to_s
+  #     #=> "0.22360679774997896964091736687313e1"
+  #
+  def self?.hypot: (BigDecimal, BigDecimal, Numeric) -> BigDecimal
+
+  # Inverse of +frexp+.
+  # Returns the value of fraction * 10**exponent.
+  #
+  #   BigMath.ldexp(BigDecimal("0.123456e0"), 3)
+  #   #=> 0.123456e3
+  #
+  def self?.ldexp: (BigDecimal, Integer) -> BigDecimal
+
+  # Computes the natural logarithm of the absolute value of the gamma function
+  # of +decimal+ to the specified number of digits of precision, +numeric+ and its sign.
+  #
+  #   BigMath.lgamma(BigDecimal('0.5'), 32)
+  #   #=> [0.57236494292470008707171367567653e0, 1]
+  #
+  def self?.lgamma: (BigDecimal, Numeric) -> [BigDecimal, Integer]
+
   # Computes the natural logarithm of `decimal` to the specified number of digits
   # of precision, `numeric`.
   #
@@ -91,6 +218,20 @@ module BigMath
   #
   def self?.log: (BigDecimal, Numeric prec) -> BigDecimal
 
+  # Computes the base 2 logarithm of `decimal` to the specified number of digits
+  # of precision, `numeric`.
+  #
+  # If `decimal` is zero or negative, raises Math::DomainError.
+  #
+  # If `decimal` is positive infinity, returns Infinity.
+  #
+  # If `decimal` is NaN, returns NaN.
+  #
+  #     BigMath.log2(BigDecimal('3'), 32).to_s
+  #     #=> "0.15849625007211561814537389439478e1"
+  #
+  def self?.log2: (BigDecimal, Numeric) -> BigDecimal
+
   # <!--
   #   rdoc-file=ext/bigdecimal/lib/bigdecimal/math.rb
   #   - sin(decimal, numeric) -> BigDecimal
@@ -105,6 +246,16 @@ module BigMath
   #
   def self?.sin: (BigDecimal x, Numeric prec) -> BigDecimal
 
+  # Computes the hyperbolic sine of `decimal` to the specified number of digits of
+  # precision, `numeric`.
+  #
+  # If `decimal` is NaN, returns NaN.
+  #
+  #     BigMath.sinh(BigDecimal('1'), 32).to_s
+  #     #=> "0.11752011936438014568823818505956e1"
+  #
+  def self?.sinh: (BigDecimal, Numeric) -> BigDecimal
+
   # <!--
   #   rdoc-file=ext/bigdecimal/lib/bigdecimal/math.rb
   #   - sqrt(decimal, numeric) -> BigDecimal
@@ -116,4 +267,14 @@ module BigMath
   #     #=> "0.1414213562373095048801688724e1"
   #
   def self?.sqrt: (BigDecimal x, Numeric prec) -> BigDecimal
+
+  # Computes the hyperbolic tangent of `decimal` to the specified number of digits
+  # of precision, `numeric`.
+  #
+  # If `decimal` is NaN, returns NaN.
+  #
+  #     BigMath.tanh(BigDecimal('1'), 32).to_s
+  #     #=> "0.76159415595576488811945828260479e0"
+  #
+  def self?.tanh: (BigDecimal, Numeric) -> BigDecimal
 end

data/stdlib/cgi/0/core.rbs

@@ -1,5 +1,15 @@
 # <!-- rdoc-file=lib/cgi/escape.rb -->
-# :stopdoc
+# Since Ruby 4.0, CGI is a small holder for various escaping methods, included
+# from CGI::Escape
+#
+#     require 'cgi/escape'
+#
+#     CGI.escape("Ruby programming language")
+#     #=> "Ruby+programming+language"
+#     CGI.escapeURIComponent("Ruby programming language")
+#     #=> "Ruby%20programming%20language"
+#
+# See CGI::Escape module for methods list and their description.
 #
 class CGI
   include CGI::Util

data/stdlib/cgi-escape/0/escape.rbs

@@ -1,5 +1,15 @@
 # <!-- rdoc-file=lib/cgi/escape.rb -->
-# :stopdoc
+# Since Ruby 4.0, CGI is a small holder for various escaping methods, included
+# from CGI::Escape
+#
+#     require 'cgi/escape'
+#
+#     CGI.escape("Ruby programming language")
+#     #=> "Ruby+programming+language"
+#     CGI.escapeURIComponent("Ruby programming language")
+#     #=> "Ruby%20programming%20language"
+#
+# See CGI::Escape module for methods list and their description.
 #
 class CGI
   include Escape
@@ -7,7 +17,7 @@ class CGI
   extend Escape
 
   # <!-- rdoc-file=lib/cgi/escape.rb -->
-  # Escape/unescape for CGI, HTML, URI.
+  # Web-related escape/unescape functionality.
   #
   module Escape
     # <!--
@@ -15,7 +25,7 @@ class CGI
     #   - escape(string)
     # -->
     # URL-encode a string into application/x-www-form-urlencoded. Space characters
-    # (+" "+) are encoded with plus signs (+"+"+)
+    # (`" "`) are encoded with plus signs (`"+"`)
     #     url_encoded_string = CGI.escape("'Stop!' said Fred")
     #        # => "%27Stop%21%27+said+Fred"
     #
@@ -45,7 +55,7 @@ class CGI
     #   rdoc-file=lib/cgi/escape.rb
     #   - escapeHTML(string)
     # -->
-    # Escape special characters in HTML, namely '&"<>
+    # Escape special characters in HTML, namely `'&\"<>`
     #     CGI.escapeHTML('Usage: foo "bar" <baz>')
     #        # => "Usage: foo &quot;bar&quot; &lt;baz&gt;"
     #
@@ -55,20 +65,24 @@ class CGI
     #   rdoc-file=lib/cgi/escape.rb
     #   - escapeURIComponent(string)
     # -->
-    # URL-encode a string following RFC 3986 Space characters (+" "+) are encoded
-    # with (+"%20"+)
+    # URL-encode a string following RFC 3986 Space characters (`" "`) are encoded
+    # with (`"%20"`)
     #     url_encoded_string = CGI.escapeURIComponent("'Stop!' said Fred")
     #        # => "%27Stop%21%27%20said%20Fred"
     #
     def escapeURIComponent: (string) -> String
 
-    # <!-- rdoc-file=lib/cgi/escape.rb -->
-    # Synonym for CGI.escapeElement(str)
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - escape_element(string, *elements)
+    # -->
     #
     alias escape_element escapeElement
 
-    # <!-- rdoc-file=lib/cgi/escape.rb -->
-    # Synonym for CGI.escapeHTML(str)
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - escape_html(string)
+    # -->
     #
     alias escape_html escapeHTML
 
@@ -101,7 +115,7 @@ class CGI
     #   rdoc-file=lib/cgi/escape.rb
     #   - unescapeElement(string, *elements)
     # -->
-    # Undo escaping such as that done by CGI.escapeElement()
+    # Undo escaping such as that done by CGI.escapeElement
     #
     #     print CGI.unescapeElement(
     #             CGI.escapeHTML('<BR><A HREF="url"></A>'), "A", "IMG")
@@ -133,13 +147,17 @@ class CGI
     #
     def unescapeURIComponent: (string) -> String
 
-    # <!-- rdoc-file=lib/cgi/escape.rb -->
-    # Synonym for CGI.unescapeElement(str)
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - unescape_element(string, *elements)
+    # -->
     #
     alias unescape_element unescapeElement
 
-    # <!-- rdoc-file=lib/cgi/escape.rb -->
-    # Synonym for CGI.unescapeHTML(str)
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - unescape_html(string)
+    # -->
     #
     alias unescape_html unescapeHTML