1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
|
class BigDecimal < Numeric
# BigDecimal::ROUND_MODE
type round_mode = 256
type round_mode_integer = 1 | 2 | 3 | 4 | 5 | 6 | 7
type round_mode_symbol = :up | :down | :half_up | :half_down | :half_even | :ceiling | :floor | :truncate | :banker | :default
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - _load(p1)
# -->
# Internal method used to provide marshalling support. See the Marshal module.
#
def self._load: (String) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - BigDecimal.double_fig -> integer
# -->
# Returns the number of digits a Float object is allowed to have; the result is
# system-dependent:
#
# BigDecimal.double_fig # => 16
#
def self.double_fig: () -> Integer
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - interpret_loosely(p1)
# -->
#
def self.interpret_loosely: (string) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - BigDecimal.limit(digits)
# -->
# Limit the number of significant digits in newly created BigDecimal numbers to
# the specified value. Rounding is performed as necessary, as specified by
# BigDecimal.mode.
#
# A limit of 0, the default, means no upper limit.
#
# The limit specified by this method takes less priority over any limit
# specified to instance methods such as ceil, floor, truncate, or round.
#
def self.limit: (?Integer? digits) -> Integer
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - BigDecimal.mode(mode, setting = nil) -> integer
# -->
# Returns an integer representing the mode settings for exception handling and
# rounding.
#
# These modes control exception handling:
#
# * BigDecimal::EXCEPTION_NaN.
# * BigDecimal::EXCEPTION_INFINITY.
# * BigDecimal::EXCEPTION_UNDERFLOW.
# * BigDecimal::EXCEPTION_OVERFLOW.
# * BigDecimal::EXCEPTION_ZERODIVIDE.
# * BigDecimal::EXCEPTION_ALL.
#
# Values for `setting` for exception handling:
#
# * `true`: sets the given `mode` to `true`.
# * `false`: sets the given `mode` to `false`.
# * `nil`: does not modify the mode settings.
#
# You can use method BigDecimal.save_exception_mode to temporarily change, and
# then automatically restore, exception modes.
#
# For clarity, some examples below begin by setting all exception modes to
# `false`.
#
# This mode controls the way rounding is to be performed:
#
# * BigDecimal::ROUND_MODE
#
# You can use method BigDecimal.save_rounding_mode to temporarily change, and
# then automatically restore, the rounding mode.
#
# **NaNs**
#
# Mode BigDecimal::EXCEPTION_NaN controls behavior when a BigDecimal NaN is
# created.
#
# Settings:
#
# * `false` (default): Returns `BigDecimal('NaN')`.
# * `true`: Raises FloatDomainError.
#
# Examples:
#
# BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false) # => 0
# BigDecimal('NaN') # => NaN
# BigDecimal.mode(BigDecimal::EXCEPTION_NaN, true) # => 2
# BigDecimal('NaN') # Raises FloatDomainError
#
# **Infinities**
#
# Mode BigDecimal::EXCEPTION_INFINITY controls behavior when a BigDecimal
# Infinity or -Infinity is created. Settings:
#
# * `false` (default): Returns `BigDecimal('Infinity')` or
# `BigDecimal('-Infinity')`.
# * `true`: Raises FloatDomainError.
#
# Examples:
#
# BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false) # => 0
# BigDecimal('Infinity') # => Infinity
# BigDecimal('-Infinity') # => -Infinity
# BigDecimal.mode(BigDecimal::EXCEPTION_INFINITY, true) # => 1
# BigDecimal('Infinity') # Raises FloatDomainError
# BigDecimal('-Infinity') # Raises FloatDomainError
#
# **Underflow**
#
# Mode BigDecimal::EXCEPTION_UNDERFLOW controls behavior when a BigDecimal
# underflow occurs. Settings:
#
# * `false` (default): Returns `BigDecimal('0')` or `BigDecimal('-Infinity')`.
# * `true`: Raises FloatDomainError.
#
# Examples:
#
# BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false) # => 0
# def flow_under
# x = BigDecimal('0.1')
# 100.times { x *= x }
# end
# flow_under # => 100
# BigDecimal.mode(BigDecimal::EXCEPTION_UNDERFLOW, true) # => 4
# flow_under # Raises FloatDomainError
#
# **Overflow**
#
# Mode BigDecimal::EXCEPTION_OVERFLOW controls behavior when a BigDecimal
# overflow occurs. Settings:
#
# * `false` (default): Returns `BigDecimal('Infinity')` or
# `BigDecimal('-Infinity')`.
# * `true`: Raises FloatDomainError.
#
# Examples:
#
# BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false) # => 0
# def flow_over
# x = BigDecimal('10')
# 100.times { x *= x }
# end
# flow_over # => 100
# BigDecimal.mode(BigDecimal::EXCEPTION_OVERFLOW, true) # => 1
# flow_over # Raises FloatDomainError
#
# **Zero Division**
#
# Mode BigDecimal::EXCEPTION_ZERODIVIDE controls behavior when a zero-division
# occurs. Settings:
#
# * `false` (default): Returns `BigDecimal('Infinity')` or
# `BigDecimal('-Infinity')`.
# * `true`: Raises FloatDomainError.
#
# Examples:
#
# BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false) # => 0
# one = BigDecimal('1')
# zero = BigDecimal('0')
# one / zero # => Infinity
# BigDecimal.mode(BigDecimal::EXCEPTION_ZERODIVIDE, true) # => 16
# one / zero # Raises FloatDomainError
#
# **All Exceptions**
#
# Mode BigDecimal::EXCEPTION_ALL controls all of the above:
#
# BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false) # => 0
# BigDecimal.mode(BigDecimal::EXCEPTION_ALL, true) # => 23
#
# **Rounding**
#
# Mode BigDecimal::ROUND_MODE controls the way rounding is to be performed; its
# `setting` values are:
#
# * `ROUND_UP`: Round away from zero. Aliased as `:up`.
# * `ROUND_DOWN`: Round toward zero. Aliased as `:down` and `:truncate`.
# * `ROUND_HALF_UP`: Round toward the nearest neighbor; if the neighbors are
# equidistant, round away from zero. Aliased as `:half_up` and `:default`.
# * `ROUND_HALF_DOWN`: Round toward the nearest neighbor; if the neighbors are
# equidistant, round toward zero. Aliased as `:half_down`.
# * `ROUND_HALF_EVEN` (Banker's rounding): Round toward the nearest neighbor;
# if the neighbors are equidistant, round toward the even neighbor. Aliased
# as `:half_even` and `:banker`.
# * `ROUND_CEILING`: Round toward positive infinity. Aliased as `:ceiling` and
# `:ceil`.
# * `ROUND_FLOOR`: Round toward negative infinity. Aliased as `:floor:`.
#
def self.mode: (round_mode, ?(round_mode_integer | round_mode_symbol)) -> Integer
| (Integer exception_mode, ?bool? setting) -> Integer
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - BigDecimal.save_exception_mode { ... }
# -->
# Execute the provided block, but preserve the exception mode
#
# BigDecimal.save_exception_mode do
# BigDecimal.mode(BigDecimal::EXCEPTION_OVERFLOW, false)
# BigDecimal.mode(BigDecimal::EXCEPTION_NaN, false)
#
# BigDecimal(BigDecimal('Infinity'))
# BigDecimal(BigDecimal('-Infinity'))
# BigDecimal(BigDecimal('NaN'))
# end
#
# For use with the BigDecimal::EXCEPTION_*
#
# See BigDecimal.mode
#
def self.save_exception_mode: () { (?nil) -> void } -> void
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - BigDecimal.save_limit { ... }
# -->
# Execute the provided block, but preserve the precision limit
#
# BigDecimal.limit(100)
# puts BigDecimal.limit
# BigDecimal.save_limit do
# BigDecimal.limit(200)
# puts BigDecimal.limit
# end
# puts BigDecimal.limit
#
def self.save_limit: () { (?nil) -> void } -> void
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - BigDecimal.save_rounding_mode { ... }
# -->
# Execute the provided block, but preserve the rounding mode
#
# BigDecimal.save_rounding_mode do
# BigDecimal.mode(BigDecimal::ROUND_MODE, :up)
# puts BigDecimal.mode(BigDecimal::ROUND_MODE)
# end
#
# For use with the BigDecimal::ROUND_*
#
# See BigDecimal.mode
#
def self.save_rounding_mode: () { (?nil) -> void } -> void
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - a % b
# - a.modulo(b)
# -->
# Returns the modulus from dividing by b.
#
# See BigDecimal#divmod.
#
def %: (real | BigDecimal) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - *(p1)
# -->
#
def *: (real | BigDecimal) -> BigDecimal
| (Complex) -> Complex
# <!--
# rdoc-file=lib/bigdecimal.rb
# - self ** other -> bigdecimal
# -->
# Returns the BigDecimal value of `self` raised to power `other`:
#
# b = BigDecimal('3.14')
# b ** 2 # => 0.98596e1
# b ** 2.0 # => 0.98596e1
# b ** Rational(2, 1) # => 0.98596e1
#
# Related: BigDecimal#power.
#
def **: (real | BigDecimal) -> BigDecimal
| (Complex) -> Complex
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - self + value -> bigdecimal
# -->
# Returns the BigDecimal sum of `self` and `value`:
#
# b = BigDecimal('111111.111') # => 0.111111111e6
# b + 2 # => 0.111113111e6
# b + 2.0 # => 0.111113111e6
# b + Rational(2, 1) # => 0.111113111e6
# b + Complex(2, 0) # => (0.111113111e6+0i)
#
# See the [Note About
# Precision](BigDecimal.html#class-BigDecimal-label-A+Note+About+Precision).
#
def +: (real | BigDecimal) -> BigDecimal
| (Complex) -> Complex
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - +big_decimal -> self
# -->
# Returns `self`:
#
# +BigDecimal(5) # => 0.5e1
# +BigDecimal(-5) # => -0.5e1
#
def +@: () -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - self - value -> bigdecimal
# -->
# Returns the BigDecimal difference of `self` and `value`:
#
# b = BigDecimal('333333.333') # => 0.333333333e6
# b - 2 # => 0.333331333e6
# b - 2.0 # => 0.333331333e6
# b - Rational(2, 1) # => 0.333331333e6
# b - Complex(2, 0) # => (0.333331333e6+0i)
#
# See the [Note About
# Precision](BigDecimal.html#class-BigDecimal-label-A+Note+About+Precision).
#
def -: (real | BigDecimal) -> BigDecimal
| (Complex) -> Complex
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - -self -> bigdecimal
# -->
# Returns the BigDecimal negation of self:
#
# b0 = BigDecimal('1.5')
# b1 = -b0 # => -0.15e1
# b2 = -b1 # => 0.15e1
#
def -@: () -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - a / b -> bigdecimal
# -->
# Divide by the specified value.
#
# The result precision will be the precision of the larger operand, but its
# minimum is 2*Float::DIG.
#
# See BigDecimal#div. See BigDecimal#quo.
#
def /: (real | BigDecimal) -> BigDecimal
| (Complex) -> Complex
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - self < other -> true or false
# -->
# Returns `true` if `self` is less than `other`, `false` otherwise:
#
# b = BigDecimal('1.5') # => 0.15e1
# b < 2 # => true
# b < 2.0 # => true
# b < Rational(2, 1) # => true
# b < 1.5 # => false
#
# Raises an exception if the comparison cannot be made.
#
def <: (real | BigDecimal) -> bool
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - self <= other -> true or false
# -->
# Returns `true` if `self` is less or equal to than `other`, `false` otherwise:
#
# b = BigDecimal('1.5') # => 0.15e1
# b <= 2 # => true
# b <= 2.0 # => true
# b <= Rational(2, 1) # => true
# b <= 1.5 # => true
# b < 1 # => false
#
# Raises an exception if the comparison cannot be made.
#
def <=: (real | BigDecimal) -> bool
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - <=>(p1)
# -->
# The comparison operator. a <=> b is 0 if a == b, 1 if a > b, -1 if a < b.
#
def <=>: (untyped) -> Integer?
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - ==(p1)
# -->
# Tests for value equality; returns true if the values are equal.
#
# The == and === operators and the eql? method have the same implementation for
# BigDecimal.
#
# Values may be coerced to perform the comparison:
#
# BigDecimal('1.0') == 1.0 #=> true
#
def ==: (untyped) -> bool
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Tests for value equality; returns true if the values are equal.
#
# The == and === operators and the eql? method have the same implementation for
# BigDecimal.
#
# Values may be coerced to perform the comparison:
#
# BigDecimal('1.0') == 1.0 #=> true
#
def ===: (untyped) -> bool
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - self > other -> true or false
# -->
# Returns `true` if `self` is greater than `other`, `false` otherwise:
#
# b = BigDecimal('1.5')
# b > 1 # => true
# b > 1.0 # => true
# b > Rational(1, 1) # => true
# b > 2 # => false
#
# Raises an exception if the comparison cannot be made.
#
def >: (real | BigDecimal) -> bool
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - self >= other -> true or false
# -->
# Returns `true` if `self` is greater than or equal to `other`, `false`
# otherwise:
#
# b = BigDecimal('1.5')
# b >= 1 # => true
# b >= 1.0 # => true
# b >= Rational(1, 1) # => true
# b >= 1.5 # => true
# b > 2 # => false
#
# Raises an exception if the comparison cannot be made.
#
def >=: (real | BigDecimal) -> bool
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - _dump -> string
# -->
# Returns a string representing the marshalling of `self`. See module Marshal.
#
# inf = BigDecimal('Infinity') # => Infinity
# dumped = inf._dump # => "9:Infinity"
# BigDecimal._load(dumped) # => Infinity
#
def _dump: (?untyped) -> String
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - abs -> bigdecimal
# -->
# Returns the BigDecimal absolute value of `self`:
#
# BigDecimal('5').abs # => 0.5e1
# BigDecimal('-3').abs # => 0.3e1
#
def abs: () -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - add(value, ndigits) -> new_bigdecimal
# -->
# Returns the BigDecimal sum of `self` and `value` with a precision of `ndigits`
# decimal digits.
#
# When `ndigits` is less than the number of significant digits in the sum, the
# sum is rounded to that number of digits, according to the current rounding
# mode; see BigDecimal.mode.
#
# Examples:
#
# # Set the rounding mode.
# BigDecimal.mode(BigDecimal::ROUND_MODE, :half_up)
# b = BigDecimal('111111.111')
# b.add(1, 0) # => 0.111112111e6
# b.add(1, 3) # => 0.111e6
# b.add(1, 6) # => 0.111112e6
# b.add(1, 15) # => 0.111112111e6
# b.add(1.0, 15) # => 0.111112111e6
# b.add(Rational(1, 1), 15) # => 0.111112111e6
#
def add: (real | BigDecimal value, Integer digits) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - ceil(n)
# -->
# Return the smallest integer greater than or equal to the value, as a
# BigDecimal.
#
# BigDecimal('3.14159').ceil #=> 4
# BigDecimal('-9.1').ceil #=> -9
#
# If n is specified and positive, the fractional part of the result has no more
# than that many digits.
#
# If n is specified and negative, at least that many digits to the left of the
# decimal point will be 0 in the result.
#
# BigDecimal('3.14159').ceil(3) #=> 3.142
# BigDecimal('13345.234').ceil(-2) #=> 13400.0
#
def ceil: () -> Integer
| (int n) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - clone()
# -->
#
def clone: () -> self
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - coerce(p1)
# -->
# The coerce method provides support for Ruby type coercion. It is not enabled
# by default.
#
# This means that binary operations like + * / or - can often be performed on a
# BigDecimal and an object of another type, if the other object can be coerced
# into a BigDecimal value.
#
# e.g.
# a = BigDecimal("1.0")
# b = a / 2.0 #=> 0.5
#
# Note that coercing a String to a BigDecimal is not supported by default; it
# requires a special compile-time option when building Ruby.
#
def coerce: (Numeric) -> [ BigDecimal, BigDecimal ]
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - div(value) -> integer
# - div(value, digits) -> bigdecimal or integer
# -->
# Divide by the specified value.
#
# digits
# : If specified and less than the number of significant digits of the result,
# the result is rounded to that number of digits, according to
# BigDecimal.mode.
#
# If digits is 0, the result is the same as for the / operator or #quo.
#
# If digits is not specified, the result is an integer, by analogy with
# Float#div; see also BigDecimal#divmod.
#
#
# See BigDecimal#/. See BigDecimal#quo.
#
# Examples:
#
# a = BigDecimal("4")
# b = BigDecimal("3")
#
# a.div(b, 3) # => 0.133e1
#
# a.div(b, 0) # => 0.1333333333333333333e1
# a / b # => 0.1333333333333333333e1
# a.quo(b) # => 0.1333333333333333333e1
#
# a.div(b) # => 1
#
def div: (real | BigDecimal value) -> Integer
| (real | BigDecimal value, int digits) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - divmod(value)
# -->
# Divides by the specified value, and returns the quotient and modulus as
# BigDecimal numbers. The quotient is rounded towards negative infinity.
#
# For example:
#
# require 'bigdecimal'
#
# a = BigDecimal("42")
# b = BigDecimal("9")
#
# q, m = a.divmod(b)
#
# c = q * b + m
#
# a == c #=> true
#
# The quotient q is (a/b).floor, and the modulus is the amount that must be
# added to q * b to get a.
#
def divmod: (real | BigDecimal) -> [ Integer, BigDecimal ]
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - dup()
# -->
#
def dup: () -> self
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Tests for value equality; returns true if the values are equal.
#
# The == and === operators and the eql? method have the same implementation for
# BigDecimal.
#
# Values may be coerced to perform the comparison:
#
# BigDecimal('1.0') == 1.0 #=> true
#
def eql?: (untyped) -> bool
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - exponent()
# -->
# Returns the exponent of the BigDecimal number, as an Integer.
#
# If the number can be represented as 0.xxxxxx*10**n where xxxxxx is a string of
# digits with no leading zeros, then n is the exponent.
#
def exponent: () -> Integer
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - finite?()
# -->
# Returns True if the value is finite (not NaN or infinite).
#
def finite?: () -> bool
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - fix()
# -->
# Return the integer part of the number, as a BigDecimal.
#
def fix: () -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - floor(n)
# -->
# Return the largest integer less than or equal to the value, as a BigDecimal.
#
# BigDecimal('3.14159').floor #=> 3
# BigDecimal('-9.1').floor #=> -10
#
# If n is specified and positive, the fractional part of the result has no more
# than that many digits.
#
# If n is specified and negative, at least that many digits to the left of the
# decimal point will be 0 in the result.
#
# BigDecimal('3.14159').floor(3) #=> 3.141
# BigDecimal('13345.234').floor(-2) #=> 13300.0
#
def floor: () -> Integer
| (int n) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - frac()
# -->
# Return the fractional part of the number, as a BigDecimal.
#
def frac: () -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - hash -> integer
# -->
# Returns the integer hash value for `self`.
#
# Two instances of BigDecimal have the same hash value if and only if they have
# equal:
#
# * Sign.
# * Fractional part.
# * Exponent.
#
def hash: () -> Integer
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - infinite?()
# -->
# Returns nil, -1, or +1 depending on whether the value is finite, -Infinity, or
# +Infinity.
#
def infinite?: () -> Integer?
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - inspect()
# -->
# Returns a string representation of self.
#
# BigDecimal("1234.5678").inspect
# #=> "0.12345678e4"
#
def inspect: () -> String
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Returns the modulus from dividing by b.
#
# See BigDecimal#divmod.
#
def modulo: (real | BigDecimal b) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - mult(other, ndigits) -> bigdecimal
# -->
# Returns the BigDecimal product of `self` and `value` with a precision of
# `ndigits` decimal digits.
#
# When `ndigits` is less than the number of significant digits in the sum, the
# sum is rounded to that number of digits, according to the current rounding
# mode; see BigDecimal.mode.
#
# Examples:
#
# # Set the rounding mode.
# BigDecimal.mode(BigDecimal::ROUND_MODE, :half_up)
# b = BigDecimal('555555.555')
# b.mult(3, 0) # => 0.1666666665e7
# b.mult(3, 3) # => 0.167e7
# b.mult(3, 6) # => 0.166667e7
# b.mult(3, 15) # => 0.1666666665e7
# b.mult(3.0, 0) # => 0.1666666665e7
# b.mult(Rational(3, 1), 0) # => 0.1666666665e7
# b.mult(Complex(3, 0), 0) # => (0.1666666665e7+0.0i)
#
def mult: (real | BigDecimal value, int digits) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - nan?()
# -->
# Returns True if the value is Not a Number.
#
def nan?: () -> bool
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - nonzero?()
# -->
# Returns self if the value is non-zero, nil otherwise.
#
def nonzero?: () -> self?
# <!--
# rdoc-file=lib/bigdecimal.rb
# - power(n)
# - power(n, prec)
# -->
# Returns the value raised to the power of n.
#
# Also available as the operator **.
#
def power: (real | BigDecimal n, ?int prec) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - quo(value) -> bigdecimal
# - quo(value, digits) -> bigdecimal
# -->
# Divide by the specified value.
#
# digits
# : If specified and less than the number of significant digits of the result,
# the result is rounded to the given number of digits, according to the
# rounding mode indicated by BigDecimal.mode.
#
# If digits is 0 or omitted, the result is the same as for the / operator.
#
#
# See BigDecimal#/. See BigDecimal#div.
#
def quo: (real | BigDecimal) -> BigDecimal
| (Complex) -> Complex
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - remainder(value)
# -->
# Returns the remainder from dividing by the value.
#
# x.remainder(y) means x-y*(x/y).truncate
#
def remainder: (real | BigDecimal) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - round(n, mode)
# -->
# Round to the nearest integer (by default), returning the result as a
# BigDecimal if n is specified, or as an Integer if it isn't.
#
# BigDecimal('3.14159').round #=> 3
# BigDecimal('8.7').round #=> 9
# BigDecimal('-9.9').round #=> -10
#
# BigDecimal('3.14159').round(2).class.name #=> "BigDecimal"
# BigDecimal('3.14159').round.class.name #=> "Integer"
#
# If n is specified and positive, the fractional part of the result has no more
# than that many digits.
#
# If n is specified and negative, at least that many digits to the left of the
# decimal point will be 0 in the result, and return value will be an Integer.
#
# BigDecimal('3.14159').round(3) #=> 3.142
# BigDecimal('13345.234').round(-2) #=> 13300
#
# The value of the optional mode argument can be used to determine how rounding
# is performed; see BigDecimal.mode.
#
def round: () -> Integer
| (int n) -> (Integer | BigDecimal)
| (int n, round_mode_integer | round_mode_symbol) -> BigDecimal
| (?int n, half: :up | :down | :even) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - sign()
# -->
# Returns the sign of the value.
#
# Returns a positive value if > 0, a negative value if < 0. It behaves the same
# with zeros - it returns a positive value for a positive zero (BigDecimal('0'))
# and a negative value for a negative zero (BigDecimal('-0')).
#
# The specific value returned indicates the type and sign of the BigDecimal, as
# follows:
#
# BigDecimal::SIGN_NaN
# : value is Not a Number
#
# BigDecimal::SIGN_POSITIVE_ZERO
# : value is +0
#
# BigDecimal::SIGN_NEGATIVE_ZERO
# : value is -0
#
# BigDecimal::SIGN_POSITIVE_INFINITE
# : value is +Infinity
#
# BigDecimal::SIGN_NEGATIVE_INFINITE
# : value is -Infinity
#
# BigDecimal::SIGN_POSITIVE_FINITE
# : value is positive
#
# BigDecimal::SIGN_NEGATIVE_FINITE
# : value is negative
#
def sign: () -> Integer
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - split()
# -->
# Splits a BigDecimal number into four parts, returned as an array of values.
#
# The first value represents the sign of the BigDecimal, and is -1 or 1, or 0 if
# the BigDecimal is Not a Number.
#
# The second value is a string representing the significant digits of the
# BigDecimal, with no leading zeros.
#
# The third value is the base used for arithmetic (currently always 10) as an
# Integer.
#
# The fourth value is an Integer exponent.
#
# If the BigDecimal can be represented as 0.xxxxxx*10**n, then xxxxxx is the
# string of significant digits with no leading zeros, and n is the exponent.
#
# From these values, you can translate a BigDecimal to a float as follows:
#
# sign, significant_digits, base, exponent = a.split
# f = sign * "0.#{significant_digits}".to_f * (base ** exponent)
#
# (Note that the to_f method is provided as a more convenient way to translate a
# BigDecimal to a Float.)
#
def split: () -> [ Integer, String, Integer, Integer ]
# <!--
# rdoc-file=lib/bigdecimal.rb
# - sqrt(prec)
# -->
# Returns the square root of the value.
#
# Result has at least prec significant digits.
#
def sqrt: (int n) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - sub(value, digits) -> bigdecimal
# -->
# Subtract the specified value.
#
# e.g.
# c = a.sub(b,n)
#
# digits
# : If specified and less than the number of significant digits of the result,
# the result is rounded to that number of digits, according to
# BigDecimal.mode.
#
def sub: (real | BigDecimal value, int digits) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - to_f()
# -->
# Returns a new Float object having approximately the same value as the
# BigDecimal number. Normal accuracy limits and built-in errors of binary Float
# arithmetic apply.
#
def to_f: () -> Float
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - to_i()
# -->
# Returns the value as an Integer.
#
# If the BigDecimal is infinity or NaN, raises FloatDomainError.
#
def to_i: () -> Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Returns the value as an Integer.
#
# If the BigDecimal is infinity or NaN, raises FloatDomainError.
#
def to_int: () -> Integer
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - to_r()
# -->
# Converts a BigDecimal to a Rational.
#
def to_r: () -> Rational
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - to_s(s)
# -->
# Converts the value to a string.
#
# The default format looks like 0.xxxxEnn.
#
# The optional parameter s consists of either an integer; or an optional '+' or
# ' ', followed by an optional number, followed by an optional 'E' or 'F'.
#
# If there is a '+' at the start of s, positive values are returned with a
# leading '+'.
#
# A space at the start of s returns positive values with a leading space.
#
# If s contains a number, a space is inserted after each group of that many
# digits, starting from '.' and counting outwards.
#
# If s ends with an 'E', engineering notation (0.xxxxEnn) is used.
#
# If s ends with an 'F', conventional floating point notation is used.
#
# Examples:
#
# BigDecimal('-1234567890123.45678901234567890').to_s('5F')
# #=> '-123 45678 90123.45678 90123 45678 9'
#
# BigDecimal('1234567890123.45678901234567890').to_s('+8F')
# #=> '+12345 67890123.45678901 23456789'
#
# BigDecimal('1234567890123.45678901234567890').to_s(' F')
# #=> ' 1234567890123.4567890123456789'
#
def to_s: (?String | int s) -> String
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - truncate(n)
# -->
# Truncate to the nearest integer (by default), returning the result as a
# BigDecimal.
#
# BigDecimal('3.14159').truncate #=> 3
# BigDecimal('8.7').truncate #=> 8
# BigDecimal('-9.9').truncate #=> -9
#
# If n is specified and positive, the fractional part of the result has no more
# than that many digits.
#
# If n is specified and negative, at least that many digits to the left of the
# decimal point will be 0 in the result.
#
# BigDecimal('3.14159').truncate(3) #=> 3.141
# BigDecimal('13345.234').truncate(-2) #=> 13300.0
#
def truncate: () -> Integer
| (int n) -> BigDecimal
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - zero?()
# -->
# Returns True if the value is zero.
#
def zero?: () -> bool
private
def initialize_copy: (self) -> self
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Base value used in internal calculations. On a 32 bit system, BASE is 10000,
# indicating that calculation is done in groups of 4 digits. (If it were larger,
# BASE**2 wouldn't fit in 32 bits, so you couldn't guarantee that two groups
# could always be multiplied together without overflow.)
#
BASE: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Determines whether overflow, underflow or zero divide result in an exception
# being thrown. See BigDecimal.mode.
#
EXCEPTION_ALL: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Determines what happens when the result of a computation is infinity. See
# BigDecimal.mode.
#
EXCEPTION_INFINITY: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Determines what happens when the result of a computation is not a number
# (NaN). See BigDecimal.mode.
#
EXCEPTION_NaN: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Determines what happens when the result of a computation is an overflow (a
# result too large to be represented). See BigDecimal.mode.
#
EXCEPTION_OVERFLOW: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Determines what happens when the result of a computation is an underflow (a
# result too small to be represented). See BigDecimal.mode.
#
EXCEPTION_UNDERFLOW: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Determines what happens when a division by zero is performed. See
# BigDecimal.mode.
#
EXCEPTION_ZERODIVIDE: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Special value constants
#
INFINITY: BigDecimal
NAN: BigDecimal
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Round towards +Infinity. See BigDecimal.mode.
#
ROUND_CEILING: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that values should be rounded towards zero. See BigDecimal.mode.
#
ROUND_DOWN: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Round towards -Infinity. See BigDecimal.mode.
#
ROUND_FLOOR: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that digits >= 6 should be rounded up, others rounded down. See
# BigDecimal.mode.
#
ROUND_HALF_DOWN: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Round towards the even neighbor. See BigDecimal.mode.
#
ROUND_HALF_EVEN: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that digits >= 5 should be rounded up, others rounded down. See
# BigDecimal.mode.
#
ROUND_HALF_UP: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Determines what happens when a result must be rounded in order to fit in the
# appropriate number of significant digits. See BigDecimal.mode.
#
ROUND_MODE: round_mode
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that values should be rounded away from zero. See BigDecimal.mode.
#
ROUND_UP: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that a value is negative and finite. See BigDecimal.sign.
#
SIGN_NEGATIVE_FINITE: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that a value is negative and infinite. See BigDecimal.sign.
#
SIGN_NEGATIVE_INFINITE: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that a value is -0. See BigDecimal.sign.
#
SIGN_NEGATIVE_ZERO: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that a value is not a number. See BigDecimal.sign.
#
SIGN_NaN: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that a value is positive and finite. See BigDecimal.sign.
#
SIGN_POSITIVE_FINITE: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that a value is positive and infinite. See BigDecimal.sign.
#
SIGN_POSITIVE_INFINITE: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# Indicates that a value is +0. See BigDecimal.sign.
#
SIGN_POSITIVE_ZERO: Integer
# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
# The version of bigdecimal library
#
VERSION: String
end
%a{annotate:rdoc:skip}
module Kernel
private
# <!--
# rdoc-file=ext/bigdecimal/bigdecimal.c
# - BigDecimal(value, exception: true) -> bigdecimal
# - BigDecimal(value, ndigits, exception: true) -> bigdecimal
# -->
# Returns the BigDecimal converted from `value` with a precision of `ndigits`
# decimal digits.
#
# When `ndigits` is less than the number of significant digits in the value, the
# result is rounded to that number of digits, according to the current rounding
# mode; see BigDecimal.mode.
#
# When `ndigits` is 0, the number of digits to correctly represent a float
# number is determined automatically.
#
# Returns `value` converted to a BigDecimal, depending on the type of `value`:
#
# * Integer, Float, Rational, Complex, or BigDecimal: converted directly:
#
# # Integer, Complex, or BigDecimal value does not require ndigits; ignored if given.
# BigDecimal(2) # => 0.2e1
# BigDecimal(Complex(2, 0)) # => 0.2e1
# BigDecimal(BigDecimal(2)) # => 0.2e1
# # Float or Rational value requires ndigits.
# BigDecimal(2.0, 0) # => 0.2e1
# BigDecimal(Rational(2, 1), 0) # => 0.2e1
#
# * String: converted by parsing if it contains an integer or floating-point
# literal; leading and trailing whitespace is ignored:
#
# # String does not require ndigits; ignored if given.
# BigDecimal('2') # => 0.2e1
# BigDecimal('2.0') # => 0.2e1
# BigDecimal('0.2e1') # => 0.2e1
# BigDecimal(' 2.0 ') # => 0.2e1
#
# * Other type that responds to method `:to_str`: first converted to a string,
# then converted to a BigDecimal, as above.
#
# * Other type:
#
# * Raises an exception if keyword argument `exception` is `true`.
# * Returns `nil` if keyword argument `exception` is `false`.
#
# Raises an exception if `value` evaluates to a Float and `digits` is larger
# than Float::DIG + 1.
#
def self?.BigDecimal: (real | string | BigDecimal initial, ?int digits, ?exception: bool) -> BigDecimal
end
%a{annotate:rdoc:skip}
class Integer
# <!--
# rdoc-file=numeric.c
# - self / numeric -> numeric_result
# -->
# Performs division; for integer `numeric`, truncates the result to an integer:
#
# 4 / 3 # => 1
# 4 / -3 # => -2
# -4 / 3 # => -2
# -4 / -3 # => 1
#
# For other +numeric+, returns non-integer result:
#
# 4 / 3.0 # => 1.3333333333333333
# 4 / Rational(3, 1) # => (4/3)
# 4 / Complex(3, 0) # => ((4/3)+0i)
#
def /: (BigDecimal) -> BigDecimal
| ...
# <!--
# rdoc-file=numeric.c
# - self * numeric -> numeric_result
# -->
# Performs multiplication:
#
# 4 * 2 # => 8
# 4 * -2 # => -8
# -4 * 2 # => -8
# 4 * 2.0 # => 8.0
# 4 * Rational(1, 3) # => (4/3)
# 4 * Complex(2, 0) # => (8+0i)
#
def *: (BigDecimal) -> BigDecimal
| ...
# <!--
# rdoc-file=numeric.c
# - self + numeric -> numeric_result
# -->
# Performs addition:
#
# 2 + 2 # => 4
# -2 + 2 # => 0
# -2 + -2 # => -4
# 2 + 2.0 # => 4.0
# 2 + Rational(2, 1) # => (4/1)
# 2 + Complex(2, 0) # => (4+0i)
#
def +: (BigDecimal) -> BigDecimal
| ...
# <!--
# rdoc-file=numeric.c
# - self - numeric -> numeric_result
# -->
# Performs subtraction:
#
# 4 - 2 # => 2
# -4 - 2 # => -6
# -4 - -2 # => -2
# 4 - 2.0 # => 2.0
# 4 - Rational(2, 1) # => (2/1)
# 4 - Complex(2, 0) # => (2+0i)
#
def -: (BigDecimal) -> BigDecimal
| ...
end
%a{annotate:rdoc:skip}
class Float
# <!--
# rdoc-file=numeric.c
# - self / other -> numeric
# -->
# Returns a new Float which is the result of dividing `self` by `other`:
#
# f = 3.14
# f / 2 # => 1.57
# f / 2.0 # => 1.57
# f / Rational(2, 1) # => 1.57
# f / Complex(2, 0) # => (1.57+0.0i)
#
def /: (BigDecimal) -> BigDecimal
| ...
# <!--
# rdoc-file=numeric.c
# - self * other -> numeric
# -->
# Returns a new Float which is the product of `self` and `other`:
#
# f = 3.14
# f * 2 # => 6.28
# f * 2.0 # => 6.28
# f * Rational(1, 2) # => 1.57
# f * Complex(2, 0) # => (6.28+0.0i)
#
def *: (BigDecimal) -> BigDecimal
| ...
# <!--
# rdoc-file=numeric.c
# - self + other -> numeric
# -->
# Returns a new Float which is the sum of `self` and `other`:
#
# f = 3.14
# f + 1 # => 4.140000000000001
# f + 1.0 # => 4.140000000000001
# f + Rational(1, 1) # => 4.140000000000001
# f + Complex(1, 0) # => (4.140000000000001+0i)
#
def +: (BigDecimal) -> BigDecimal
| ...
# <!--
# rdoc-file=numeric.c
# - self - other -> numeric
# -->
# Returns a new Float which is the difference of `self` and `other`:
#
# f = 3.14
# f - 1 # => 2.14
# f - 1.0 # => 2.14
# f - Rational(1, 1) # => 2.14
# f - Complex(1, 0) # => (2.14+0i)
#
def -: (BigDecimal) -> BigDecimal
| ...
end
%a{annotate:rdoc:skip}
class Rational
# <!--
# rdoc-file=rational.c
# - rat / numeric -> numeric
# - rat.quo(numeric) -> numeric
# -->
# Performs division.
#
# Rational(2, 3) / Rational(2, 3) #=> (1/1)
# Rational(900) / Rational(1) #=> (900/1)
# Rational(-2, 9) / Rational(-9, 2) #=> (4/81)
# Rational(9, 8) / 4 #=> (9/32)
# Rational(20, 9) / 9.8 #=> 0.22675736961451246
#
def /: (BigDecimal) -> BigDecimal
| ...
# <!--
# rdoc-file=rational.c
# - rat * numeric -> numeric
# -->
# Performs multiplication.
#
# Rational(2, 3) * Rational(2, 3) #=> (4/9)
# Rational(900) * Rational(1) #=> (900/1)
# Rational(-2, 9) * Rational(-9, 2) #=> (1/1)
# Rational(9, 8) * 4 #=> (9/2)
# Rational(20, 9) * 9.8 #=> 21.77777777777778
#
def *: (BigDecimal) -> BigDecimal
| ...
# <!--
# rdoc-file=rational.c
# - rat + numeric -> numeric
# -->
# Performs addition.
#
# Rational(2, 3) + Rational(2, 3) #=> (4/3)
# Rational(900) + Rational(1) #=> (901/1)
# Rational(-2, 9) + Rational(-9, 2) #=> (-85/18)
# Rational(9, 8) + 4 #=> (41/8)
# Rational(20, 9) + 9.8 #=> 12.022222222222222
#
def +: (BigDecimal) -> BigDecimal
| ...
# <!--
# rdoc-file=rational.c
# - rat - numeric -> numeric
# -->
# Performs subtraction.
#
# Rational(2, 3) - Rational(2, 3) #=> (0/1)
# Rational(900) - Rational(1) #=> (899/1)
# Rational(-2, 9) - Rational(-9, 2) #=> (77/18)
# Rational(9, 8) - 4 #=> (-23/8)
# Rational(20, 9) - 9.8 #=> -7.577777777777778
#
def -: (BigDecimal) -> BigDecimal
| ...
end
%a{annotate:rdoc:skip}
class Complex
# <!--
# rdoc-file=complex.c
# - complex / numeric -> new_complex
# -->
# Returns the quotient of `self` and `numeric`:
#
# Complex.rect(2, 3) / Complex.rect(2, 3) # => (1+0i)
# Complex.rect(900) / Complex.rect(1) # => (900+0i)
# Complex.rect(-2, 9) / Complex.rect(-9, 2) # => ((36/85)-(77/85)*i)
# Complex.rect(9, 8) / 4 # => ((9/4)+2i)
# Complex.rect(20, 9) / 9.8 # => (2.0408163265306123+0.9183673469387754i)
#
def /: (BigDecimal) -> Complex
| ...
# <!--
# rdoc-file=complex.c
# - complex * numeric -> new_complex
# -->
# Returns the product of `self` and `numeric`:
#
# Complex.rect(2, 3) * Complex.rect(2, 3) # => (-5+12i)
# Complex.rect(900) * Complex.rect(1) # => (900+0i)
# Complex.rect(-2, 9) * Complex.rect(-9, 2) # => (0-85i)
# Complex.rect(9, 8) * 4 # => (36+32i)
# Complex.rect(20, 9) * 9.8 # => (196.0+88.2i)
#
def *: (BigDecimal) -> Complex
| ...
# <!--
# rdoc-file=complex.c
# - complex + numeric -> new_complex
# -->
# Returns the sum of `self` and `numeric`:
#
# Complex.rect(2, 3) + Complex.rect(2, 3) # => (4+6i)
# Complex.rect(900) + Complex.rect(1) # => (901+0i)
# Complex.rect(-2, 9) + Complex.rect(-9, 2) # => (-11+11i)
# Complex.rect(9, 8) + 4 # => (13+8i)
# Complex.rect(20, 9) + 9.8 # => (29.8+9i)
#
def +: (BigDecimal) -> Complex
| ...
# <!--
# rdoc-file=complex.c
# - complex - numeric -> new_complex
# -->
# Returns the difference of `self` and `numeric`:
#
# Complex.rect(2, 3) - Complex.rect(2, 3) # => (0+0i)
# Complex.rect(900) - Complex.rect(1) # => (899+0i)
# Complex.rect(-2, 9) - Complex.rect(-9, 2) # => (7+7i)
# Complex.rect(9, 8) - 4 # => (5+8i)
# Complex.rect(20, 9) - 9.8 # => (10.2+9i)
#
def -: (BigDecimal) -> Complex
| ...
end
|