rbs 3.10.0.pre.2 → 3.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/c-check.yml +1 -1
  3. data/.github/workflows/comments.yml +2 -2
  4. data/.github/workflows/ruby.yml +7 -7
  5. data/CHANGELOG.md +49 -0
  6. data/core/array.rbs +56 -3
  7. data/core/complex.rbs +32 -21
  8. data/core/encoding.rbs +3 -7
  9. data/core/enumerable.rbs +1 -1
  10. data/core/enumerator.rbs +18 -1
  11. data/core/fiber.rbs +2 -1
  12. data/core/file.rbs +1 -1
  13. data/core/file_test.rbs +1 -1
  14. data/core/float.rbs +208 -21
  15. data/core/gc.rbs +4 -9
  16. data/core/hash.rbs +4 -4
  17. data/core/integer.rbs +78 -38
  18. data/core/io/buffer.rbs +18 -7
  19. data/core/io.rbs +8 -8
  20. data/core/kernel.rbs +8 -8
  21. data/core/module.rbs +17 -6
  22. data/core/numeric.rbs +8 -8
  23. data/core/object_space.rbs +13 -20
  24. data/core/pathname.rbs +2 -3
  25. data/core/ractor.rbs +4 -4
  26. data/core/range.rbs +1 -1
  27. data/core/rational.rbs +37 -24
  28. data/core/rbs/unnamed/argf.rbs +1 -1
  29. data/core/regexp.rbs +3 -3
  30. data/core/ruby.rbs +53 -0
  31. data/core/rubygems/version.rbs +2 -3
  32. data/core/set.rbs +86 -64
  33. data/core/string.rbs +275 -141
  34. data/core/thread.rbs +9 -9
  35. data/core/trace_point.rbs +7 -4
  36. data/lib/rbs/test/type_check.rb +1 -0
  37. data/lib/rbs/version.rb +1 -1
  38. data/lib/rdoc/discover.rb +1 -1
  39. data/stdlib/bigdecimal/0/big_decimal.rbs +100 -82
  40. data/stdlib/bigdecimal-math/0/big_math.rbs +169 -8
  41. data/stdlib/date/0/date.rbs +67 -59
  42. data/stdlib/date/0/date_time.rbs +1 -1
  43. data/stdlib/json/0/json.rbs +1 -0
  44. data/stdlib/objspace/0/objspace.rbs +1 -1
  45. data/stdlib/openssl/0/openssl.rbs +150 -80
  46. data/stdlib/psych/0/psych.rbs +3 -3
  47. data/stdlib/stringio/0/stringio.rbs +796 -37
  48. data/stdlib/strscan/0/string_scanner.rbs +1 -1
  49. data/stdlib/tempfile/0/tempfile.rbs +2 -2
  50. data/stdlib/time/0/time.rbs +1 -1
  51. data/stdlib/timeout/0/timeout.rbs +63 -7
  52. data/stdlib/uri/0/generic.rbs +1 -1
  53. metadata +3 -2
data/core/thread.rbs CHANGED
@@ -1523,7 +1523,7 @@ end
1523
1523
  #
1524
1524
  class Thread::Mutex < Object
1525
1525
  # <!--
1526
- # rdoc-file=thread_sync.c
1526
+ # rdoc-file=thread_sync.rb
1527
1527
  # - mutex.lock -> self
1528
1528
  # -->
1529
1529
  # Attempts to grab the lock and waits if it isn't available. Raises
@@ -1532,7 +1532,7 @@ class Thread::Mutex < Object
1532
1532
  def lock: () -> self
1533
1533
 
1534
1534
  # <!--
1535
- # rdoc-file=thread_sync.c
1535
+ # rdoc-file=thread_sync.rb
1536
1536
  # - mutex.locked? -> true or false
1537
1537
  # -->
1538
1538
  # Returns `true` if this lock is currently held by some thread.
@@ -1540,7 +1540,7 @@ class Thread::Mutex < Object
1540
1540
  def locked?: () -> bool
1541
1541
 
1542
1542
  # <!--
1543
- # rdoc-file=thread_sync.c
1543
+ # rdoc-file=thread_sync.rb
1544
1544
  # - mutex.owned? -> true or false
1545
1545
  # -->
1546
1546
  # Returns `true` if this lock is currently held by current thread.
@@ -1548,7 +1548,7 @@ class Thread::Mutex < Object
1548
1548
  def owned?: () -> bool
1549
1549
 
1550
1550
  # <!--
1551
- # rdoc-file=thread_sync.c
1551
+ # rdoc-file=thread_sync.rb
1552
1552
  # - mutex.synchronize { ... } -> result of the block
1553
1553
  # -->
1554
1554
  # Obtains a lock, runs the block, and releases the lock when the block
@@ -1557,7 +1557,7 @@ class Thread::Mutex < Object
1557
1557
  def synchronize: [X] () { () -> X } -> X
1558
1558
 
1559
1559
  # <!--
1560
- # rdoc-file=thread_sync.c
1560
+ # rdoc-file=thread_sync.rb
1561
1561
  # - mutex.try_lock -> true or false
1562
1562
  # -->
1563
1563
  # Attempts to obtain the lock and returns immediately. Returns `true` if the
@@ -1566,11 +1566,11 @@ class Thread::Mutex < Object
1566
1566
  def try_lock: () -> bool
1567
1567
 
1568
1568
  # <!--
1569
- # rdoc-file=thread_sync.c
1570
- # - mutex.unlock -> self
1569
+ # rdoc-file=thread_sync.rb
1570
+ # - mutex.lock -> self
1571
1571
  # -->
1572
- # Releases the lock. Raises `ThreadError` if `mutex` wasn't locked by the
1573
- # current thread.
1572
+ # Attempts to grab the lock and waits if it isn't available. Raises
1573
+ # `ThreadError` if `mutex` was locked by the current thread.
1574
1574
  #
1575
1575
  def unlock: () -> self
1576
1576
  end
data/core/trace_point.rbs CHANGED
@@ -25,7 +25,8 @@
25
25
  # change. Instead, it is recommended to specify the types of events you want to
26
26
  # use.
27
27
  #
28
- # To filter what is traced, you can pass any of the following as `events`:
28
+ # To filter what is traced, you can pass any number of the following as
29
+ # `events`:
29
30
  #
30
31
  # `:line`
31
32
  # : Execute an expression or statement on a new line.
@@ -107,8 +108,8 @@ class TracePoint
107
108
  #
108
109
  # A block must be given; otherwise, an ArgumentError is raised.
109
110
  #
110
- # If the trace method isn't included in the given events filter, a RuntimeError
111
- # is raised.
111
+ # If the trace method isn't supported for the given event(s) filter, a
112
+ # RuntimeError is raised.
112
113
  #
113
114
  # TracePoint.trace(:line) do |tp|
114
115
  # p tp.raised_exception
@@ -122,7 +123,9 @@ class TracePoint
122
123
  # end
123
124
  # $tp.lineno #=> access from outside (RuntimeError)
124
125
  #
125
- # Access from other threads is also forbidden.
126
+ # Access from other ractors, threads or fibers is forbidden. TracePoints are
127
+ # active per-ractor so if you enable a TracePoint in one ractor, other ractors
128
+ # will not be affected.
126
129
  #
127
130
  def self.new: (*_ToSym events) { (instance tp) -> void } -> instance
128
131
 
@@ -364,6 +364,7 @@ module RBS
364
364
  value(val, builder.expand_alias2(type.name.absolute!, type.args))
365
365
  when Types::Tuple
366
366
  Test.call(val, IS_AP, ::Array) &&
367
+ type.types.length == val.length &&
367
368
  type.types.map.with_index {|ty, index| value(val[index], ty) }.all?
368
369
  when Types::Record
369
370
  Test::call(val, IS_AP, ::Hash) &&
data/lib/rbs/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module RBS
4
- VERSION = "3.10.0.pre.2"
4
+ VERSION = "3.10.0"
5
5
  end
data/lib/rdoc/discover.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  begin
4
- gem 'rdoc', '~> 6.16'
4
+ gem 'rdoc', '>= 6.16'
5
5
  require 'rdoc_plugin/parser'
6
6
  module RDoc
7
7
  class Parser
@@ -609,7 +609,7 @@ class BigDecimal < Numeric
609
609
  # The quotient q is (a/b).floor, and the modulus is the amount that must be
610
610
  # added to q * b to get a.
611
611
  #
612
- def divmod: (Numeric) -> [ BigDecimal, BigDecimal ]
612
+ def divmod: (Numeric) -> [ Integer, BigDecimal ]
613
613
 
614
614
  # <!--
615
615
  # rdoc-file=ext/bigdecimal/bigdecimal.c
@@ -783,20 +783,6 @@ class BigDecimal < Numeric
783
783
  #
784
784
  def power: (Numeric n, int prec) -> BigDecimal
785
785
 
786
- # <!--
787
- # rdoc-file=ext/bigdecimal/bigdecimal.c
788
- # - precs -> array
789
- # -->
790
- # Returns an Array of two Integer values that represent platform-dependent
791
- # internal storage properties.
792
- #
793
- # This method is deprecated and will be removed in the future. Instead, use
794
- # BigDecimal#n_significant_digits for obtaining the number of significant digits
795
- # in scientific notation, and BigDecimal#precision for obtaining the number of
796
- # digits in decimal notation.
797
- #
798
- def precs: () -> [ Integer, Integer ]
799
-
800
786
  # <!--
801
787
  # rdoc-file=ext/bigdecimal/bigdecimal.c
802
788
  # - quo(value) -> bigdecimal
@@ -1274,33 +1260,35 @@ class Integer
1274
1260
 
1275
1261
  # <!--
1276
1262
  # rdoc-file=numeric.c
1277
- # - self / numeric -> numeric_result
1263
+ # - self / other -> numeric
1278
1264
  # -->
1279
- # Performs division; for integer `numeric`, truncates the result to an integer:
1265
+ # Returns the quotient of `self` and `other`.
1266
+ #
1267
+ # For integer `other`, truncates the result to an integer:
1280
1268
  #
1281
- # 4 / 3 # => 1
1282
- # 4 / -3 # => -2
1283
- # -4 / 3 # => -2
1284
- # -4 / -3 # => 1
1269
+ # 4 / 3 # => 1
1270
+ # 4 / -3 # => -2
1271
+ # -4 / 3 # => -2
1272
+ # -4 / -3 # => 1
1285
1273
  #
1286
- # For other +numeric+, returns non-integer result:
1274
+ # For non-integer `other`, returns a non-integer result:
1287
1275
  #
1288
- # 4 / 3.0 # => 1.3333333333333333
1289
- # 4 / Rational(3, 1) # => (4/3)
1290
- # 4 / Complex(3, 0) # => ((4/3)+0i)
1276
+ # 4 / 3.0 # => 1.3333333333333333
1277
+ # 4 / Rational(3, 1) # => (4/3)
1278
+ # 4 / Complex(3, 0) # => ((4/3)+0i)
1291
1279
  #
1292
1280
  def /: (BigDecimal) -> BigDecimal
1293
1281
  | ...
1294
1282
 
1295
1283
  # <!--
1296
1284
  # rdoc-file=numeric.c
1297
- # - self * numeric -> numeric_result
1285
+ # - self * other -> numeric
1298
1286
  # -->
1299
- # Performs multiplication:
1287
+ # Returns the numeric product of `self` and `other`:
1300
1288
  #
1301
1289
  # 4 * 2 # => 8
1302
- # 4 * -2 # => -8
1303
1290
  # -4 * 2 # => -8
1291
+ # 4 * -2 # => -8
1304
1292
  # 4 * 2.0 # => 8.0
1305
1293
  # 4 * Rational(1, 3) # => (4/3)
1306
1294
  # 4 * Complex(2, 0) # => (8+0i)
@@ -1310,25 +1298,29 @@ class Integer
1310
1298
 
1311
1299
  # <!--
1312
1300
  # rdoc-file=numeric.c
1313
- # - self + numeric -> numeric_result
1301
+ # - self + other -> numeric
1314
1302
  # -->
1315
- # Performs addition:
1303
+ # Returns the sum of `self` and `other`:
1304
+ #
1305
+ # 1 + 1 # => 2
1306
+ # 1 + -1 # => 0
1307
+ # 1 + 0 # => 1
1308
+ # 1 + -2 # => -1
1309
+ # 1 + Complex(1, 0) # => (2+0i)
1310
+ # 1 + Rational(1, 1) # => (2/1)
1316
1311
  #
1317
- # 2 + 2 # => 4
1318
- # -2 + 2 # => 0
1319
- # -2 + -2 # => -4
1320
- # 2 + 2.0 # => 4.0
1321
- # 2 + Rational(2, 1) # => (4/1)
1322
- # 2 + Complex(2, 0) # => (4+0i)
1312
+ # For a computation involving Floats, the result may be inexact (see Float#+):
1313
+ #
1314
+ # 1 + 3.14 # => 4.140000000000001
1323
1315
  #
1324
1316
  def +: (BigDecimal) -> BigDecimal
1325
1317
  | ...
1326
1318
 
1327
1319
  # <!--
1328
1320
  # rdoc-file=numeric.c
1329
- # - self - numeric -> numeric_result
1321
+ # - self - other -> numeric
1330
1322
  # -->
1331
- # Performs subtraction:
1323
+ # Returns the difference of `self` and `other`:
1332
1324
  #
1333
1325
  # 4 - 2 # => 2
1334
1326
  # -4 - 2 # => -6
@@ -1368,7 +1360,7 @@ class Float
1368
1360
  # rdoc-file=numeric.c
1369
1361
  # - self / other -> numeric
1370
1362
  # -->
1371
- # Returns a new Float which is the result of dividing `self` by `other`:
1363
+ # Returns the quotient of `self` and `other`:
1372
1364
  #
1373
1365
  # f = 3.14
1374
1366
  # f / 2 # => 1.57
@@ -1383,7 +1375,7 @@ class Float
1383
1375
  # rdoc-file=numeric.c
1384
1376
  # - self * other -> numeric
1385
1377
  # -->
1386
- # Returns a new Float which is the product of `self` and `other`:
1378
+ # Returns the numeric product of `self` and `other`:
1387
1379
  #
1388
1380
  # f = 3.14
1389
1381
  # f * 2 # => 6.28
@@ -1396,15 +1388,20 @@ class Float
1396
1388
 
1397
1389
  # <!--
1398
1390
  # rdoc-file=numeric.c
1399
- # - self + other -> numeric
1391
+ # - self + other -> float or complex
1400
1392
  # -->
1401
- # Returns a new Float which is the sum of `self` and `other`:
1393
+ # Returns the sum of `self` and `other`; the result may be inexact (see Float):
1402
1394
  #
1403
- # f = 3.14
1404
- # f + 1 # => 4.140000000000001
1405
- # f + 1.0 # => 4.140000000000001
1406
- # f + Rational(1, 1) # => 4.140000000000001
1407
- # f + Complex(1, 0) # => (4.140000000000001+0i)
1395
+ # 3.14 + 0 # => 3.14
1396
+ # 3.14 + 1 # => 4.140000000000001
1397
+ # -3.14 + 0 # => -3.14
1398
+ # -3.14 + 1 # => -2.14
1399
+ #
1400
+ # 3.14 + -3.14 # => 0.0
1401
+ # -3.14 + -3.14 # => -6.28
1402
+ #
1403
+ # 3.14 + Complex(1, 0) # => (4.140000000000001+0i)
1404
+ # 3.14 + Rational(1, 1) # => 4.140000000000001
1408
1405
  #
1409
1406
  def +: (BigDecimal) -> BigDecimal
1410
1407
  | ...
@@ -1413,7 +1410,7 @@ class Float
1413
1410
  # rdoc-file=numeric.c
1414
1411
  # - self - other -> numeric
1415
1412
  # -->
1416
- # Returns a new Float which is the difference of `self` and `other`:
1413
+ # Returns the difference of `self` and `other`:
1417
1414
  #
1418
1415
  # f = 3.14
1419
1416
  # f - 1 # => 2.14
@@ -1468,10 +1465,9 @@ class Rational
1468
1465
 
1469
1466
  # <!--
1470
1467
  # rdoc-file=rational.c
1471
- # - rat / numeric -> numeric
1472
- # - rat.quo(numeric) -> numeric
1468
+ # - self / other -> numeric
1473
1469
  # -->
1474
- # Performs division.
1470
+ # Returns the quotient of `self` and `other`:
1475
1471
  #
1476
1472
  # Rational(2, 3) / Rational(2, 3) #=> (1/1)
1477
1473
  # Rational(900) / Rational(1) #=> (900/1)
@@ -1484,39 +1480,50 @@ class Rational
1484
1480
 
1485
1481
  # <!--
1486
1482
  # rdoc-file=rational.c
1487
- # - rat * numeric -> numeric
1483
+ # - self * other -> numeric
1488
1484
  # -->
1489
- # Performs multiplication.
1485
+ # Returns the numeric product of `self` and `other`:
1490
1486
  #
1491
- # Rational(2, 3) * Rational(2, 3) #=> (4/9)
1492
- # Rational(900) * Rational(1) #=> (900/1)
1493
- # Rational(-2, 9) * Rational(-9, 2) #=> (1/1)
1494
- # Rational(9, 8) * 4 #=> (9/2)
1495
- # Rational(20, 9) * 9.8 #=> 21.77777777777778
1487
+ # Rational(9, 8) * 4 #=> (9/2)
1488
+ # Rational(20, 9) * 9.8 #=> 21.77777777777778
1489
+ # Rational(9, 8) * Complex(1, 2) # => ((9/8)+(9/4)*i)
1490
+ # Rational(2, 3) * Rational(2, 3) #=> (4/9)
1491
+ # Rational(900) * Rational(1) #=> (900/1)
1492
+ # Rational(-2, 9) * Rational(-9, 2) #=> (1/1)
1496
1493
  #
1497
1494
  def *: (BigDecimal) -> BigDecimal
1498
1495
  | ...
1499
1496
 
1500
1497
  # <!--
1501
1498
  # rdoc-file=rational.c
1502
- # - rat + numeric -> numeric
1499
+ # - self + other -> numeric
1503
1500
  # -->
1504
- # Performs addition.
1501
+ # Returns the sum of `self` and `other`:
1502
+ #
1503
+ # Rational(2, 3) + 0 # => (2/3)
1504
+ # Rational(2, 3) + 1 # => (5/3)
1505
+ # Rational(2, 3) + -1 # => (-1/3)
1506
+ #
1507
+ # Rational(2, 3) + Complex(1, 0) # => ((5/3)+0i)
1505
1508
  #
1506
- # Rational(2, 3) + Rational(2, 3) #=> (4/3)
1507
- # Rational(900) + Rational(1) #=> (901/1)
1508
- # Rational(-2, 9) + Rational(-9, 2) #=> (-85/18)
1509
- # Rational(9, 8) + 4 #=> (41/8)
1510
- # Rational(20, 9) + 9.8 #=> 12.022222222222222
1509
+ # Rational(2, 3) + Rational(1, 1) # => (5/3)
1510
+ # Rational(2, 3) + Rational(3, 2) # => (13/6)
1511
+ # Rational(2, 3) + Rational(3.0, 2.0) # => (13/6)
1512
+ # Rational(2, 3) + Rational(3.1, 2.1) # => (30399297484750849/14186338826217063)
1513
+ #
1514
+ # For a computation involving Floats, the result may be inexact (see Float#+):
1515
+ #
1516
+ # Rational(2, 3) + 1.0 # => 1.6666666666666665
1517
+ # Rational(2, 3) + Complex(1.0, 0.0) # => (1.6666666666666665+0.0i)
1511
1518
  #
1512
1519
  def +: (BigDecimal) -> BigDecimal
1513
1520
  | ...
1514
1521
 
1515
1522
  # <!--
1516
1523
  # rdoc-file=rational.c
1517
- # - rat - numeric -> numeric
1524
+ # - self - other -> numeric
1518
1525
  # -->
1519
- # Performs subtraction.
1526
+ # Returns the difference of `self` and `other`:
1520
1527
  #
1521
1528
  # Rational(2, 3) - Rational(2, 3) #=> (0/1)
1522
1529
  # Rational(900) - Rational(1) #=> (899/1)
@@ -1553,9 +1560,9 @@ class Complex
1553
1560
 
1554
1561
  # <!--
1555
1562
  # rdoc-file=complex.c
1556
- # - complex / numeric -> new_complex
1563
+ # - self / other -> complex
1557
1564
  # -->
1558
- # Returns the quotient of `self` and `numeric`:
1565
+ # Returns the quotient of `self` and `other`:
1559
1566
  #
1560
1567
  # Complex.rect(2, 3) / Complex.rect(2, 3) # => (1+0i)
1561
1568
  # Complex.rect(900) / Complex.rect(1) # => (900+0i)
@@ -1568,39 +1575,50 @@ class Complex
1568
1575
 
1569
1576
  # <!--
1570
1577
  # rdoc-file=complex.c
1571
- # - complex * numeric -> new_complex
1578
+ # - self * other -> numeric
1572
1579
  # -->
1573
- # Returns the product of `self` and `numeric`:
1580
+ # Returns the numeric product of `self` and `other`:
1574
1581
  #
1582
+ # Complex.rect(9, 8) * 4 # => (36+32i)
1583
+ # Complex.rect(20, 9) * 9.8 # => (196.0+88.2i)
1575
1584
  # Complex.rect(2, 3) * Complex.rect(2, 3) # => (-5+12i)
1576
1585
  # Complex.rect(900) * Complex.rect(1) # => (900+0i)
1577
1586
  # Complex.rect(-2, 9) * Complex.rect(-9, 2) # => (0-85i)
1578
- # Complex.rect(9, 8) * 4 # => (36+32i)
1579
- # Complex.rect(20, 9) * 9.8 # => (196.0+88.2i)
1587
+ # Complex.rect(9, 8) * Rational(2, 3) # => ((6/1)+(16/3)*i)
1580
1588
  #
1581
1589
  def *: (BigDecimal) -> Complex
1582
1590
  | ...
1583
1591
 
1584
1592
  # <!--
1585
1593
  # rdoc-file=complex.c
1586
- # - complex + numeric -> new_complex
1594
+ # - self + other -> numeric
1587
1595
  # -->
1588
- # Returns the sum of `self` and `numeric`:
1596
+ # Returns the sum of `self` and `other`:
1597
+ #
1598
+ # Complex(1, 2) + 0 # => (1+2i)
1599
+ # Complex(1, 2) + 1 # => (2+2i)
1600
+ # Complex(1, 2) + -1 # => (0+2i)
1601
+ #
1602
+ # Complex(1, 2) + 1.0 # => (2.0+2i)
1603
+ #
1604
+ # Complex(1, 2) + Complex(2, 1) # => (3+3i)
1605
+ # Complex(1, 2) + Complex(2.0, 1.0) # => (3.0+3.0i)
1606
+ #
1607
+ # Complex(1, 2) + Rational(1, 1) # => ((2/1)+2i)
1608
+ # Complex(1, 2) + Rational(1, 2) # => ((3/2)+2i)
1609
+ #
1610
+ # For a computation involving Floats, the result may be inexact (see Float#+):
1589
1611
  #
1590
- # Complex.rect(2, 3) + Complex.rect(2, 3) # => (4+6i)
1591
- # Complex.rect(900) + Complex.rect(1) # => (901+0i)
1592
- # Complex.rect(-2, 9) + Complex.rect(-9, 2) # => (-11+11i)
1593
- # Complex.rect(9, 8) + 4 # => (13+8i)
1594
- # Complex.rect(20, 9) + 9.8 # => (29.8+9i)
1612
+ # Complex(1, 2) + 3.14 # => (4.140000000000001+2i)
1595
1613
  #
1596
1614
  def +: (BigDecimal) -> Complex
1597
1615
  | ...
1598
1616
 
1599
1617
  # <!--
1600
1618
  # rdoc-file=complex.c
1601
- # - complex - numeric -> new_complex
1619
+ # - self - other -> complex
1602
1620
  # -->
1603
- # Returns the difference of `self` and `numeric`:
1621
+ # Returns the difference of `self` and `other`:
1604
1622
  #
1605
1623
  # Complex.rect(2, 3) - Complex.rect(2, 3) # => (0+0i)
1606
1624
  # Complex.rect(900) - Complex.rect(1) # => (899+0i)
@@ -35,6 +35,46 @@ module BigMath
35
35
  #
36
36
  def self?.PI: (Numeric prec) -> BigDecimal
37
37
 
38
+ # Computes the arccosine of `decimal` to the specified number of digits of
39
+ # precision, `numeric`.
40
+ #
41
+ # If `decimal` is NaN, returns NaN.
42
+ #
43
+ # BigMath.acos(BigDecimal('0.5'), 32).to_s
44
+ # #=> "0.10471975511965977461542144610932e1"
45
+ #
46
+ def self?.acos: (BigDecimal, Numeric) -> BigDecimal
47
+
48
+ # Computes the inverse hyperbolic cosine of `decimal` to the specified number of
49
+ # digits of precision, `numeric`.
50
+ #
51
+ # If `decimal` is NaN, returns NaN.
52
+ #
53
+ # BigMath.acosh(BigDecimal('2'), 32).to_s
54
+ # #=> "0.1316957896924816708625046347308e1"
55
+ #
56
+ def self?.acosh: (BigDecimal, Numeric) -> BigDecimal
57
+
58
+ # Computes the arcsine of `decimal` to the specified number of digits of
59
+ # precision, `numeric`.
60
+ #
61
+ # If `decimal` is NaN, returns NaN.
62
+ #
63
+ # BigMath.asin(BigDecimal('0.5'), 32).to_s
64
+ # #=> "0.52359877559829887307710723054658e0"
65
+ #
66
+ def self?.asin: (BigDecimal, Numeric) -> BigDecimal
67
+
68
+ # Computes the inverse hyperbolic sine of `decimal` to the specified number of
69
+ # digits of precision, `numeric`.
70
+ #
71
+ # If `decimal` is NaN, returns NaN.
72
+ #
73
+ # BigMath.asinh(BigDecimal('1'), 32).to_s
74
+ # #=> "0.88137358701954302523260932497979e0"
75
+ #
76
+ def self?.asinh: (BigDecimal, Numeric) -> BigDecimal
77
+
38
78
  # <!--
39
79
  # rdoc-file=ext/bigdecimal/lib/bigdecimal/math.rb
40
80
  # - atan(decimal, numeric) -> BigDecimal
@@ -49,6 +89,32 @@ module BigMath
49
89
  #
50
90
  def self?.atan: (BigDecimal x, Numeric prec) -> BigDecimal
51
91
 
92
+ # Computes the arctangent of y and x to the specified number of digits of
93
+ # precision, `numeric`.
94
+ #
95
+ # BigMath.atan2(BigDecimal('-1'), BigDecimal('1'), 32).to_s
96
+ # #=> "-0.78539816339744830961566084581988e0"
97
+ #
98
+ def self?.atan2: (BigDecimal, BigDecimal, Numeric) -> BigDecimal
99
+
100
+ # Computes the inverse hyperbolic tangent of `decimal` to the specified number
101
+ # of digits of precision, `numeric`.
102
+ #
103
+ # If `decimal` is NaN, returns NaN.
104
+ #
105
+ # BigMath.atanh(BigDecimal('0.5'), 32).to_s
106
+ # #=> "0.54930614433405484569762261846126e0"
107
+ #
108
+ def self?.atanh: (BigDecimal, Numeric) -> BigDecimal
109
+
110
+ # Computes the cube root of `decimal` to the specified number of digits of
111
+ # precision, `numeric`.
112
+ #
113
+ # BigMath.cbrt(BigDecimal('2'), 32).to_s
114
+ # #=> "0.12599210498948731647672106072782e1"
115
+ #
116
+ def self?.cbrt: (BigDecimal, Numeric) -> BigDecimal
117
+
52
118
  # <!--
53
119
  # rdoc-file=ext/bigdecimal/lib/bigdecimal/math.rb
54
120
  # - cos(decimal, numeric) -> BigDecimal
@@ -63,10 +129,36 @@ module BigMath
63
129
  #
64
130
  def self?.cos: (BigDecimal x, Numeric prec) -> BigDecimal
65
131
 
66
- # <!--
67
- # rdoc-file=ext/bigdecimal/bigdecimal.c
68
- # - BigMath.exp(decimal, numeric) -> BigDecimal
69
- # -->
132
+ # Computes the hyperbolic cosine of `decimal` to the specified number of digits
133
+ # of precision, `numeric`.
134
+ #
135
+ # If `decimal` is NaN, returns NaN.
136
+ #
137
+ # BigMath.cosh(BigDecimal('1'), 32).to_s
138
+ # #=> "0.15430806348152437784779056207571e1"
139
+ #
140
+ def self?.cosh: (BigDecimal, Numeric) -> BigDecimal
141
+
142
+ # Computes the error function of +decimal+ to the specified number of digits of
143
+ # precision, +numeric+.
144
+ #
145
+ # If +decimal+ is NaN, returns NaN.
146
+ #
147
+ # BigMath.erf(BigDecimal('1'), 32).to_s
148
+ # #=> "0.84270079294971486934122063508261e0"
149
+ #
150
+ def self?.erf: (BigDecimal, Numeric) -> BigDecimal
151
+
152
+ # Computes the complementary error function of +decimal+ to the specified number of digits of
153
+ # precision, +numeric+.
154
+ #
155
+ # If +decimal+ is NaN, returns NaN.
156
+ #
157
+ # BigMath.erfc(BigDecimal('10'), 32).to_s
158
+ # #=> "0.20884875837625447570007862949578e-44"
159
+ #
160
+ def self?.erfc: (BigDecimal, Numeric) -> BigDecimal
161
+
70
162
  # Computes the value of e (the base of natural logarithms) raised to the power
71
163
  # of `decimal`, to the specified number of digits of precision.
72
164
  #
@@ -76,10 +168,45 @@ module BigMath
76
168
  #
77
169
  def self?.exp: (BigDecimal, Numeric prec) -> BigDecimal
78
170
 
79
- # <!--
80
- # rdoc-file=ext/bigdecimal/bigdecimal.c
81
- # - BigMath.log(decimal, numeric) -> BigDecimal
82
- # -->
171
+ # Decomposes +x+ into a normalized fraction and an integral power of ten.
172
+ #
173
+ # BigMath.frexp(BigDecimal(123.456))
174
+ # #=> [0.123456e0, 3]
175
+ #
176
+ def self?.frexp: (BigDecimal) -> [ BigDecimal, Integer ]
177
+
178
+ # Computes the gamma function of +decimal+ to the specified number of
179
+ # digits of precision, +numeric+.
180
+ #
181
+ # BigMath.gamma(BigDecimal('0.5'), 32).to_s
182
+ # #=> "0.17724538509055160272981674833411e1"
183
+ #
184
+ def self?.gamma: (BigDecimal, Numeric) -> BigDecimal
185
+
186
+ # Returns sqrt(x**2 + y**2) to the specified number of digits of precision,
187
+ # `numeric`.
188
+ #
189
+ # BigMath.hypot(BigDecimal('1'), BigDecimal('2'), 32).to_s
190
+ # #=> "0.22360679774997896964091736687313e1"
191
+ #
192
+ def self?.hypot: (BigDecimal, BigDecimal, Numeric) -> BigDecimal
193
+
194
+ # Inverse of +frexp+.
195
+ # Returns the value of fraction * 10**exponent.
196
+ #
197
+ # BigMath.ldexp(BigDecimal("0.123456e0"), 3)
198
+ # #=> 0.123456e3
199
+ #
200
+ def self?.ldexp: (BigDecimal, Integer) -> BigDecimal
201
+
202
+ # Computes the natural logarithm of the absolute value of the gamma function
203
+ # of +decimal+ to the specified number of digits of precision, +numeric+ and its sign.
204
+ #
205
+ # BigMath.lgamma(BigDecimal('0.5'), 32)
206
+ # #=> [0.57236494292470008707171367567653e0, 1]
207
+ #
208
+ def self?.lgamma: (BigDecimal, Numeric) -> [BigDecimal, Integer]
209
+
83
210
  # Computes the natural logarithm of `decimal` to the specified number of digits
84
211
  # of precision, `numeric`.
85
212
  #
@@ -91,6 +218,20 @@ module BigMath
91
218
  #
92
219
  def self?.log: (BigDecimal, Numeric prec) -> BigDecimal
93
220
 
221
+ # Computes the base 2 logarithm of `decimal` to the specified number of digits
222
+ # of precision, `numeric`.
223
+ #
224
+ # If `decimal` is zero or negative, raises Math::DomainError.
225
+ #
226
+ # If `decimal` is positive infinity, returns Infinity.
227
+ #
228
+ # If `decimal` is NaN, returns NaN.
229
+ #
230
+ # BigMath.log2(BigDecimal('3'), 32).to_s
231
+ # #=> "0.15849625007211561814537389439478e1"
232
+ #
233
+ def self?.log2: (BigDecimal, Numeric) -> BigDecimal
234
+
94
235
  # <!--
95
236
  # rdoc-file=ext/bigdecimal/lib/bigdecimal/math.rb
96
237
  # - sin(decimal, numeric) -> BigDecimal
@@ -105,6 +246,16 @@ module BigMath
105
246
  #
106
247
  def self?.sin: (BigDecimal x, Numeric prec) -> BigDecimal
107
248
 
249
+ # Computes the hyperbolic sine of `decimal` to the specified number of digits of
250
+ # precision, `numeric`.
251
+ #
252
+ # If `decimal` is NaN, returns NaN.
253
+ #
254
+ # BigMath.sinh(BigDecimal('1'), 32).to_s
255
+ # #=> "0.11752011936438014568823818505956e1"
256
+ #
257
+ def self?.sinh: (BigDecimal, Numeric) -> BigDecimal
258
+
108
259
  # <!--
109
260
  # rdoc-file=ext/bigdecimal/lib/bigdecimal/math.rb
110
261
  # - sqrt(decimal, numeric) -> BigDecimal
@@ -116,4 +267,14 @@ module BigMath
116
267
  # #=> "0.1414213562373095048801688724e1"
117
268
  #
118
269
  def self?.sqrt: (BigDecimal x, Numeric prec) -> BigDecimal
270
+
271
+ # Computes the hyperbolic tangent of `decimal` to the specified number of digits
272
+ # of precision, `numeric`.
273
+ #
274
+ # If `decimal` is NaN, returns NaN.
275
+ #
276
+ # BigMath.tanh(BigDecimal('1'), 32).to_s
277
+ # #=> "0.76159415595576488811945828260479e0"
278
+ #
279
+ def self?.tanh: (BigDecimal, Numeric) -> BigDecimal
119
280
  end