-
Notifications
You must be signed in to change notification settings - Fork 10.5k
/
Copy pathFloatingPoint.swift.gyb
1319 lines (1183 loc) · 51.8 KB
/
FloatingPoint.swift.gyb
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
// RUN: %empty-directory(%t)
// RUN: %gyb %s -o %t/FloatingPoint.swift
// RUN: %line-directive %t/FloatingPoint.swift -- %target-build-swift -parse-stdlib %t/FloatingPoint.swift -o %t/a.out
// RUN: %target-codesign %t/a.out
// RUN: %line-directive %t/FloatingPoint.swift -- %target-run %t/a.out
// REQUIRES: executable_test
// REQUIRES: rdar49026133
import Swift
import StdlibUnittest
#if !os(Windows) && (arch(i386) || arch(x86_64))
struct Float80Bits : Equatable, CustomStringConvertible {
var signAndExponent: UInt16
var significand: UInt64
init(_ signAndExponent: UInt16, _ significand: UInt64) {
self.signAndExponent = signAndExponent
self.significand = significand
}
var description: String {
return "(\(String(signAndExponent, radix: 16)) \(String(significand, radix: 16)))"
}
}
func == (lhs: Float80Bits, rhs: Float80Bits) -> Bool {
return
lhs.signAndExponent == rhs.signAndExponent &&
lhs.significand == rhs.significand
}
extension Float80 {
var bitPattern: Float80Bits {
let bits = Builtin.bitcast_FPIEEE80_Int80(self._value)
let sixtyFour = Builtin.zextOrBitCast_Int64_Int80((64 as Int64)._value)
return Float80Bits(
UInt16(Builtin.truncOrBitCast_Int80_Int16(
Builtin.lshr_Int80(bits, sixtyFour))),
UInt64(Builtin.truncOrBitCast_Int80_Int64(bits)))
}
init(bitPattern: Float80Bits) {
var result = Builtin.shl_Int80(
Builtin.zextOrBitCast_Int16_Int80(bitPattern.signAndExponent._value),
Builtin.zextOrBitCast_Int64_Int80((64 as Int64)._value))
result = Builtin.or_Int80(
result, Builtin.zextOrBitCast_Int64_Int80(bitPattern.significand._value))
self = Float80(Builtin.bitcast_Int80_FPIEEE80(result))
}
}
#endif
% for (FloatTy, BitPatternTy) in [
% ('Float', 'UInt32'),
% ('Double', 'UInt64'),
% ('Float80', 'Float80Bits')
% ]:
% if FloatTy == 'Float80':
#if !os(Windows) && (arch(i386) || arch(x86_64))
% end
func expectBitwiseEqual(
_ expected: ${FloatTy}, _ actual: ${FloatTy},
_ message: @autoclosure () -> String = "",
stackTrace: SourceLocStack = SourceLocStack(),
showFrame: Bool = true,
file: String = #file, line: UInt = #line
) {
expectEqual(expected.bitPattern, actual.bitPattern, message(),
stackTrace: stackTrace.pushIf(showFrame, file: file, line: line))
}
func expectBitwiseEqual(
bitPattern expected: ${BitPatternTy}, _ actual: ${FloatTy},
_ message: @autoclosure () -> String = "",
stackTrace: SourceLocStack = SourceLocStack(),
showFrame: Bool = true,
file: String = #file, line: UInt = #line
) {
expectBitwiseEqual(${FloatTy}(bitPattern: expected), actual, message(),
stackTrace: stackTrace.pushIf(showFrame, file: file, line: line))
}
% if FloatTy == 'Float80':
#endif
% end
% end
var FloatingPoint = TestSuite("FloatingPoint")
FloatingPoint.test("BinaryFloatingPoint/genericIntegerConversion") {
expectTrue(Double._convert(from: 0) == (value: 0, exact: true))
expectTrue(Double._convert(from: 1) == (value: 1, exact: true))
expectTrue(Double._convert(from: -1) == (value: -1, exact: true))
expectTrue(Double._convert(from: 42) == (value: 42, exact: true))
expectTrue(Double._convert(from: -42) == (value: -42, exact: true))
expectTrue(Double._convert(from: 100) == (value: 100, exact: true))
expectTrue(Double._convert(from: -100) == (value: -100, exact: true))
expectEqual(Double._convert(from: Int64.max).value, Double(Int64.max))
expectEqual(Double._convert(from: Int64.min).value, Double(Int64.min))
var x = ((Int64.max >> 11) + 1) << 11
expectEqual(Double._convert(from: x).value, Double(x))
x = (Int64.max >> 12) << 12 + 1
expectEqual(Double._convert(from: x).value, Double(x))
x = Int64.min + 1
expectEqual(Double._convert(from: x).value, Double(x))
expectEqual(Float._convert(from: Int64.max).value, Float(Int64.max))
expectEqual(Float._convert(from: Int64.min).value, Float(Int64.min))
}
FloatingPoint.test("BinaryFloatingPoint/genericFloatingPointConversion") {
expectTrue(Double._convert(from: 0 as Float) == (value: 0, exact: true))
expectTrue(Double._convert(from: -0.0 as Float) == (value: -0.0, exact: true))
expectTrue(Double._convert(from: 1 as Float) == (value: 1, exact: true))
expectTrue(Double._convert(from: -1 as Float) == (value: -1, exact: true))
expectTrue(
Double._convert(from: Float.infinity) == (value: .infinity, exact: true))
expectTrue(
Double._convert(from: -Float.infinity) == (value: -.infinity, exact: true))
expectTrue(Double._convert(from: Float.nan).value.isNaN)
expectTrue(Float._convert(from: Double.nan).value.isNaN)
expectFalse(Double._convert(from: Float.nan).value.isSignalingNaN)
expectFalse(Float._convert(from: Double.nan).value.isSignalingNaN)
expectTrue(Double._convert(from: Float.signalingNaN).value.isNaN)
expectTrue(Float._convert(from: Double.signalingNaN).value.isNaN)
let x = Float(bitPattern: Float.nan.bitPattern | 0xf)
expectEqual(
Float._convert(from: Double._convert(from: x).value).value.bitPattern,
x.bitPattern)
var y = Double(bitPattern: Double.nan.bitPattern | 0xf)
expectEqual(
Double._convert(from: Float._convert(from: y).value).value.bitPattern,
y.bitPattern)
y = Double(bitPattern: Double.nan.bitPattern | (1 << 32 - 1))
expectNotEqual(
Double._convert(from: Float._convert(from: y).value).value.bitPattern,
y.bitPattern)
expectTrue(Float._convert(from: y).value.isNaN)
expectFalse(Float._convert(from: y).exact)
expectTrue(
Float._convert(from: Double.leastNonzeroMagnitude) ==
(value: 0, exact: false))
expectTrue(
Float._convert(from: -Double.leastNonzeroMagnitude) ==
(value: -0.0, exact: false))
expectTrue(
Double._convert(from: Double.leastNonzeroMagnitude) ==
(value: .leastNonzeroMagnitude, exact: true))
expectTrue(
Double._convert(from: -Double.leastNonzeroMagnitude) ==
(value: -.leastNonzeroMagnitude, exact: true))
y = Double._convert(from: Float.leastNonzeroMagnitude).value / 2
expectTrue(Float._convert(from: y) == (value: 0, exact: false))
y.negate()
expectTrue(Float._convert(from: y) == (value: -0.0, exact: false))
y.negate()
y = y.nextUp
expectTrue(
Float._convert(from: y) == (value: .leastNonzeroMagnitude, exact: false))
y.negate()
expectTrue(
Float._convert(from: y) == (value: -.leastNonzeroMagnitude, exact: false))
expectEqual(
Float._convert(from: Double.leastNormalMagnitude).value,
Float(Double.leastNormalMagnitude))
expectEqual(
Float._convert(from: -Double.leastNormalMagnitude).value,
Float(-Double.leastNormalMagnitude))
expectEqual(Float._convert(from: Double.pi).value, 3.14159265)
y = Double._convert(from: Float._convert(from: Double.pi).value).value.nextUp
expectEqual(Float._convert(from: y).value, 3.14159265)
y.negate()
expectEqual(Float._convert(from: y).value, -3.14159265)
expectTrue(
Float._convert(from: Double.greatestFiniteMagnitude) ==
(value: .infinity, exact: false))
expectTrue(
Float._convert(from: -Double.greatestFiniteMagnitude) ==
(value: -.infinity, exact: false))
expectTrue(
Double._convert(from: Double.greatestFiniteMagnitude) ==
(value: .greatestFiniteMagnitude, exact: true))
expectTrue(
Double._convert(from: -Double.greatestFiniteMagnitude) ==
(value: -.greatestFiniteMagnitude, exact: true))
expectEqual(
Float._convert(
from: Double._convert(from: Float.greatestFiniteMagnitude).value).value,
Float.greatestFiniteMagnitude)
expectEqual(
Float._convert(
from: Double._convert(from: Float.leastNonzeroMagnitude).value).value,
Float.leastNonzeroMagnitude)
// Let's make sure that the correct value is returned when two representable
// values are equally close to the original value.
let bitPattern: UInt64 = 0b01111111111_0000000000000000000000110000000000000000000000000000
var z = Double(bitPattern: bitPattern)
expectEqual(Float._convert(from: z).value, Float(z))
z = Double(Float.greatestFiniteMagnitude) +
Double(Float.greatestFiniteMagnitude.ulp / 2)
expectEqual(Float._convert(from: z).value, Float(z))
}
func positiveOne<T: ExpressibleByIntegerLiteral>() -> T {
return 1
}
func negativeOne<T: ExpressibleByIntegerLiteral>() -> T {
return -1
}
FloatingPoint.test("Float/ExpressibleByIntegerLiteral") {
expectEqual(positiveOne(), 1.0 as Float)
expectEqual(negativeOne(), -1.0 as Float)
}
FloatingPoint.test("Float/ExpressibleByFloatLiteral") {
let x: Float = -0.0
expectBitwiseEqual(bitPattern: 0x8000_0000, x)
}
FloatingPoint.test("Float/staticProperties") {
typealias Ty = Float
// From the FloatingPoint protocol.
expectEqual(2, Ty.radix)
expectBitwiseEqual(bitPattern: 0x7fc0_0000, Ty.nan)
#if !arch(i386) // i386 does not support a signaling nans.
expectBitwiseEqual(bitPattern: 0x7fa0_0000, Ty.signalingNaN)
#endif
expectBitwiseEqual(bitPattern: 0x7f80_0000, Ty.infinity)
expectBitwiseEqual(0x1.ffff_fe__p127, Ty.greatestFiniteMagnitude)
expectBitwiseEqual(0x1.921f_b4__p1, Ty.pi)
expectBitwiseEqual(0x1.0p-23, Ty.ulpOfOne)
expectBitwiseEqual(0x1.0p-126, Ty.leastNormalMagnitude)
#if arch(arm)
expectBitwiseEqual(0x1.0p-126, Ty.leastNonzeroMagnitude)
#else
expectBitwiseEqual(0x1.0p-149, Ty.leastNonzeroMagnitude)
#endif
// From the BinaryFloatingPoint protocol.
expectEqual(8, Ty.exponentBitCount)
expectEqual(23, Ty.significandBitCount)
}
// Tests the float and int conversions work correctly. Each case is special.
#if !os(macOS) && !(os(iOS) && targetEnvironment(macCatalyst))
if #available(iOS 14.0, watchOS 7.0, tvOS 14.0, *) {
FloatingPoint.test("Float16/Int") {
expectNil(Int(exactly: Float16.infinity))
expectNil(Int(exactly: -Float16.infinity))
}
}
#endif
FloatingPoint.test("Float/UInt8") {
expectEqual(UInt8.min, UInt8(Float(UInt8.min)))
expectEqual(UInt8.max, UInt8(Float(UInt8.max)))
}
FloatingPoint.test("Float/Int8") {
expectEqual(Int8.min, Int8(Float(Int8.min)))
expectEqual(Int8.max, Int8(Float(Int8.max)))
}
FloatingPoint.test("Float/UInt16") {
expectEqual(UInt16.min, UInt16(Float(UInt16.min)))
expectEqual(UInt16.max, UInt16(Float(UInt16.max)))
}
FloatingPoint.test("Float/Int16") {
expectEqual(Int16.min, Int16(Float(Int16.min)))
expectEqual(Int16.max, Int16(Float(Int16.max)))
}
FloatingPoint.test("Float/UInt32") {
expectEqual(UInt32.min, UInt32(Float(UInt32.min)))
expectCrashLater()
expectEqual(UInt32.max, UInt32(Float(UInt32.max)))
}
FloatingPoint.test("Float/Int32") {
expectEqual(Int32.min, Int32(Float(Int32.min)))
expectCrashLater()
expectEqual(Int32.max, Int32(Float(Int32.max)))
}
FloatingPoint.test("Float/UInt64") {
expectEqual(UInt64.min, UInt64(Float(UInt64.min)))
expectCrashLater()
expectEqual(UInt64.max, UInt64(Float(UInt64.max)))
}
FloatingPoint.test("Float/Int64") {
expectEqual(Int64.min, Int64(Float(Int64.min)))
expectCrashLater()
expectEqual(Int64.max, Int64(Float(Int64.max)))
}
FloatingPoint.test("Double/ExpressibleByIntegerLiteral") {
expectEqual(positiveOne(), 1.0 as Double)
expectEqual(negativeOne(), -1.0 as Double)
}
FloatingPoint.test("Double/ExpressibleByFloatLiteral") {
let x: Double = -0.0
expectBitwiseEqual(bitPattern: 0x8000_0000_0000_0000, x)
}
FloatingPoint.test("Double/staticProperties") {
typealias Ty = Double
// From the FloatingPoint protocol.
expectEqual(2, Ty.radix)
expectBitwiseEqual(bitPattern: 0x7ff8_0000_0000_0000, Ty.nan)
#if !arch(i386) // i386 does not support a signaling nans.
expectBitwiseEqual(bitPattern: 0x7ff4_0000_0000_0000, Ty.signalingNaN)
#endif
expectBitwiseEqual(bitPattern: 0x7ff0_0000_0000_0000, Ty.infinity)
expectBitwiseEqual(0x1.ffff_ffff_ffff_f__p1023, Ty.greatestFiniteMagnitude)
expectBitwiseEqual(0x1.921f_b544_42d1_8__p1, Ty.pi)
expectBitwiseEqual(0x1.0p-52, Ty.ulpOfOne)
expectBitwiseEqual(0x1.0p-1022, Ty.leastNormalMagnitude)
#if arch(arm)
expectBitwiseEqual(0x1.0p-1022, Ty.leastNonzeroMagnitude)
#else
expectBitwiseEqual(0x1.0p-1074, Ty.leastNonzeroMagnitude)
#endif
// From the BinaryFloatingPoint protocol.
expectEqual(11, Ty.exponentBitCount)
expectEqual(52, Ty.significandBitCount)
}
FloatingPoint.test("Double/UInt8") {
expectEqual(UInt8.min, UInt8(Double(UInt8.min)))
expectEqual(UInt8.max, UInt8(Double(UInt8.max)))
}
FloatingPoint.test("Double/Int8") {
expectEqual(Int8.min, Int8(Double(Int8.min)))
expectEqual(Int8.max, Int8(Double(Int8.max)))
}
FloatingPoint.test("Double/UInt16") {
expectEqual(UInt16.min, UInt16(Double(UInt16.min)))
expectEqual(UInt16.max, UInt16(Double(UInt16.max)))
}
FloatingPoint.test("Double/Int16") {
expectEqual(Int16.min, Int16(Double(Int16.min)))
expectEqual(Int16.max, Int16(Double(Int16.max)))
}
FloatingPoint.test("Double/UInt32") {
expectEqual(UInt32.min, UInt32(Double(UInt32.min)))
expectEqual(UInt32.max, UInt32(Double(UInt32.max)))
}
FloatingPoint.test("Double/Int32") {
expectEqual(Int32.min, Int32(Double(Int32.min)))
expectEqual(Int32.max, Int32(Double(Int32.max)))
}
FloatingPoint.test("Double/UInt64") {
expectEqual(UInt64.min, UInt64(Double(UInt64.min)))
expectCrashLater()
expectEqual(UInt64.max, UInt64(Double(UInt64.max)))
}
FloatingPoint.test("Double/Int64") {
expectEqual(Int64.min, Int64(Double(Int64.min)))
expectCrashLater()
expectEqual(Int64.max, Int64(Double(Int64.max)))
}
FloatingPoint.test("Float/HashValueZero") {
let zero: Float = getFloat32(0.0)
let negativeZero: Float = getFloat32(-0.0)
expectNotEqual(zero.bitPattern, negativeZero.bitPattern)
expectEqual(zero.hashValue, negativeZero.hashValue)
}
FloatingPoint.test("Double/HashValueZero") {
let zero: Double = getFloat64(0.0)
let negativeZero: Double = getFloat64(-0.0)
expectNotEqual(zero.bitPattern, negativeZero.bitPattern)
expectEqual(zero.hashValue, negativeZero.hashValue)
}
#if arch(arm)
% for FloatSelf in ['Float32', 'Float64']:
func testSubNormalFlush(_ f: ${FloatSelf}) {
if !f.isSubnormal {
return
}
switch f.sign {
case .plus:
expectBitwiseEqual(.leastNonzeroMagnitude, f.nextUp)
expectBitwiseEqual(0.0, f.nextDown)
case .minus:
expectBitwiseEqual(-0.0, f.nextUp)
expectBitwiseEqual(-.leastNonzeroMagnitude, f.nextDown)
}
}
% end
#endif
extension FloatingPoint {
public var isQuietNaN: Bool { return isNaN && !isSignalingNaN }
}
func genericAbs<T: SignedNumeric & Comparable>(_ x: T) -> T {
return abs(x)
}
%for Self in ['Float', 'Double', 'Float80']:
% if Self == 'Float80':
#if !os(Windows) && (arch(i386) || arch(x86_64))
% end
FloatingPoint.test("${Self}.round") {
for rule in [FloatingPointRoundingRule.toNearestOrAwayFromZero,
FloatingPointRoundingRule.toNearestOrEven,
FloatingPointRoundingRule.towardZero,
FloatingPointRoundingRule.awayFromZero,
FloatingPointRoundingRule.up,
FloatingPointRoundingRule.down] {
// Zeros, integers and infinities round to themselves:
for value in [${Self}(), 1, 1/${Self}.ulpOfOne,
.greatestFiniteMagnitude, .infinity] {
expectBitwiseEqual(value, value.rounded(rule))
expectBitwiseEqual(-value, (-value).rounded(rule))
}
// NaNs "round" to NaNs:
expectTrue(${Self}.nan.rounded(rule).isNaN)
// Now let's try some inexact cases; we're going to stay close to zero,
// and check values close to (half-)integers, because those are the cases
// that people usually get wrong, and they'll reveal simple blunders like
// simply implementing the wrong rounding mode.
for base in stride(from: ${Self}(-3.5), to: 4, by: 0.5) {
for value in [base.nextDown, base, base.nextUp] {
let result = value.rounded(rule)
// Result must be integral. Since we're testing small values, we
// can simply check that Self(Int(result)) == result. For larger
// values this wouldn't be a correct test.'
expectEqual(${Self}(Int(result)), result)
let residual = value - result
// For any rounding rule, abs(residual) must be less than 1, however
// due to rounding the computation can produce 1 exactly.
expectTrue(abs(residual) <= 1)
// Remaining validation checks depend on the rounding rule.
switch rule {
case .toNearestOrAwayFromZero:
expectTrue(abs(residual) < 0.5 ||
abs(residual) == 0.5 && abs(result) > abs(value))
case .toNearestOrEven:
expectTrue(abs(residual) < 0.5 ||
abs(residual) == 0.5 && Int(result) % 2 == 0)
case .towardZero:
expectTrue(abs(result) <= abs(value))
case .awayFromZero:
expectTrue(abs(result) >= abs(value))
case .up:
expectTrue(result >= value)
case .down:
expectTrue(result <= value)
}
}
}
}
}
FloatingPoint.test("${Self}.remainder") {
// Basic sanity tests only; these are only sufficient to provide reassurance
// that a known-good remainder function (e.g. from the C stdlib) has been
// shimmed correctly. They are not sufficient for development of such a
// function, and should not be employed for that purpose.
expectTrue(${Self}(0).remainder(dividingBy: 0).isNaN)
expectTrue(${Self}(1).remainder(dividingBy: 0).isNaN)
expectTrue(${Self}.infinity.remainder(dividingBy: 0).isNaN)
expectTrue(${Self}.infinity.remainder(dividingBy: 1).isNaN)
expectEqual(0, ${Self}(0).remainder(dividingBy: .infinity))
expectEqual(1, ${Self}(1).remainder(dividingBy: .infinity))
expectEqual(-1, ${Self}(2).remainder(dividingBy: 3))
expectEqual(-1, ${Self}(3).remainder(dividingBy: 2))
expectEqual(1, ${Self}(5).remainder(dividingBy: 2))
}
FloatingPoint.test("${Self}.squareRoot") {
// Basic sanity tests only; these are only sufficient to provide reassurance
// that a known-good square root function (e.g. from the C stdlib) has been
// shimmed correctly. They are not sufficient for development of such a
// function, and should not be employed for that purpose.
expectTrue(${Self}(-1).squareRoot().isNaN)
expectTrue(${Self}.nan.squareRoot().isNaN)
expectEqual(-0, ${Self}(-0).squareRoot())
expectEqual(0, ${Self}(0).squareRoot())
expectEqual(1, ${Self}(1).squareRoot())
expectEqual(2, ${Self}(4).squareRoot())
expectEqual(.infinity, ${Self}.infinity.squareRoot())
}
FloatingPoint.test("${Self}.addingProduct") {
// Fails if fma( ) is incorrectly implemented using separate + and *,
// and validates that we have the argument order right for the shimmed
// function.
let one = ${Self}(1)
let ulp = ${Self}.ulpOfOne
expectEqual(ulp*ulp, one.addingProduct(ulp + one, ulp - one))
}
FloatingPoint.test("${Self}/LosslessStringConvertible") {
let instances = [
1.0, -1.0,
0.0, -0.0,
${Self}.infinity, -${Self}.infinity
]
checkLosslessStringConvertible(instances)
expectTrue(Float(String(Float.nan))!.isNaN)
}
FloatingPoint.test("${Self}.significandWidth") {
expectEqual(-1, ${Self}(0).significandWidth)
expectEqual(-1, ${Self}.infinity.significandWidth)
expectEqual(-1, ${Self}.nan.significandWidth)
expectEqual(${Self}.significandBitCount, ${Self}(1).nextUp.significandWidth)
expectEqual(${Self}.significandBitCount, ${Self}(1).nextDown.significandWidth)
expectEqual(0, ${Self}.ulpOfOne.significandWidth)
expectEqual(0, ${Self}(1).significandWidth)
expectEqual(0, ${Self}(2).significandWidth)
expectEqual(1, ${Self}(3).significandWidth)
}
FloatingPoint.test("${Self}.absNegativeZero") {
expectEqual(abs(${Self}(-0.0)), ${Self}(0.0))
expectEqual(genericAbs(${Self}(-0.0)), ${Self}(0.0))
}
% if Self == 'Float80':
#endif
% end
%end
let floatNextUpDownTests: [(Float, Float)] = [
(.greatestFiniteMagnitude, .infinity),
(0x1.ffff_fe__p-1, 1.0), (1.0, 0x1.0000_02__p+0),
(0.0, .leastNonzeroMagnitude),
(0x1.efff_fe__p-1, 0x1.fp-1), (0x1.fp-1, 0x1.f000_02__p-1),
]
FloatingPoint.test("Float.nextUp, .nextDown")
.forEach(in: floatNextUpDownTests) {
(prev, succ) in
#if arch(arm)
if prev.isSubnormal || succ.isSubnormal {
testSubNormalFlush(prev)
testSubNormalFlush(succ)
return
}
#endif
expectBitwiseEqual(succ, prev.nextUp)
expectBitwiseEqual(prev, succ.nextDown)
expectBitwiseEqual(-succ, (-prev).nextDown)
expectBitwiseEqual(-prev, (-succ).nextUp)
}
let doubleNextUpDownTests: [(Double, Double)] = [
(.greatestFiniteMagnitude, .infinity),
(0x1.ffff_ffff_ffff_fp-1, 1.0), (1.0, 0x1.0000_0000_0000_1p+0),
(0.0, .leastNonzeroMagnitude),
(0x1.efff_ffff_ffff_fp-1, 0x1.fp-1), (0x1.fp-1, 0x1.f000_0000_0000_1p-1),
]
FloatingPoint.test("Double.nextUp, .nextDown")
.forEach(in: doubleNextUpDownTests) {
(prev, succ) in
#if arch(arm)
if prev.isSubnormal || succ.isSubnormal {
testSubNormalFlush(prev)
testSubNormalFlush(succ)
return
}
#endif
expectBitwiseEqual(succ, prev.nextUp)
expectBitwiseEqual(prev, succ.nextDown)
expectBitwiseEqual(-succ, (-prev).nextDown)
expectBitwiseEqual(-prev, (-succ).nextUp)
}
%for Self in ['Float', 'Double']:
FloatingPoint.test("${Self}.nextUp, .nextDown/nan") {
let x = ${Self}.nan
expectTrue(x.nextUp.isNaN)
expectTrue(x.nextDown.isNaN)
expectTrue((-x).nextDown.isNaN)
expectTrue((-x).nextUp.isNaN)
}
%end
#if !os(Windows) && (arch(i386) || arch(x86_64))
FloatingPoint.test("Float80/ExpressibleByIntegerLiteral") {
expectEqual(positiveOne(), 1.0 as Float80)
expectEqual(negativeOne(), -1.0 as Float80)
}
FloatingPoint.test("Float80/ExpressibleByFloatLiteral") {
let x: Float80 = -0.0
expectBitwiseEqual(bitPattern: Float80Bits(0x8000, 0), x)
}
FloatingPoint.test("Float80/staticProperties") {
typealias Ty = Double
// From the FloatingPoint protocol.
expectEqual(2, Ty.radix)
expectBitwiseEqual(bitPattern: 0x7ff8_0000_0000_0000, Ty.nan)
#if !arch(i386) // i386 does not support a signaling nans.
expectBitwiseEqual(bitPattern: 0x7ff4_0000_0000_0000, Ty.signalingNaN)
#endif
expectBitwiseEqual(bitPattern: 0x7ff0_0000_0000_0000, Ty.infinity)
expectBitwiseEqual(0x1.ffff_ffff_ffff_f__p1023, Ty.greatestFiniteMagnitude)
expectBitwiseEqual(0x1.921f_b544_42d1_8__p1, Ty.pi)
expectBitwiseEqual(0x1.0p-52, Ty.ulpOfOne)
expectBitwiseEqual(0x1.0p-1022, Ty.leastNormalMagnitude)
expectBitwiseEqual(0x1.0p-1074, Ty.leastNonzeroMagnitude)
// From the BinaryFloatingPoint protocol.
expectEqual(11, Ty.exponentBitCount)
expectEqual(52, Ty.significandBitCount)
}
FloatingPoint.test("Float80/HashValueZero") {
let zero: Float80 = getFloat80(0.0)
let negativeZero: Float80 = getFloat80(-0.0)
expectNotEqual(zero.bitPattern, negativeZero.bitPattern)
expectEqual(zero.hashValue, negativeZero.hashValue)
}
let float80NextUpDownTests: [(Float80, Float80)] = [
(.nan, .nan),
(.greatestFiniteMagnitude, .infinity),
(0x1.ffff_ffff_ffff_fffep-1, 1.0), (1.0, 0x1.0000_0000_0000_0002p+0),
(0.0, .leastNonzeroMagnitude),
(0x1.efff_ffff_ffff_fffep-1, 0x1.fp-1),
(0x1.fp-1, 0x1.f000_0000_0000_0002p-1),
]
FloatingPoint.test("Float80.nextUp, .nextDown")
.forEach(in: float80NextUpDownTests) {
(prev, succ) in
expectBitwiseEqual(succ, prev.nextUp)
expectBitwiseEqual(prev, succ.nextDown)
expectBitwiseEqual(-succ, (-prev).nextDown)
expectBitwiseEqual(-prev, (-succ).nextUp)
}
#endif
% for FloatSelf in ['Float32', 'Float64']:
func checkFloatingPointComparison_${FloatSelf}(
_ expected: ExpectedComparisonResult,
_ lhs: ${FloatSelf}, _ rhs: ${FloatSelf},
//===--- TRACE boilerplate ----------------------------------------------===//
// @autoclosure _ message: () -> String = "",
showFrame: Bool = true,
stackTrace: SourceLocStack = SourceLocStack(),
file: String = #file, line: UInt = #line
) {
let newTrace = stackTrace.pushIf(showFrame, file: file, line: line)
let message = { "expected: lhs=\(lhs) \(expected) rhs=\(rhs)" }
expectEqual(expected.isEQ(), lhs == rhs, message(), stackTrace: newTrace)
expectEqual(expected.isNE(), lhs != rhs, message(), stackTrace: newTrace)
checkHashable(
expectedEqual: expected.isEQ(),
lhs, rhs, message(), stackTrace: newTrace)
expectEqual(expected.isLT(), lhs < rhs, message(), stackTrace: newTrace)
expectEqual(expected.isLE(), lhs <= rhs, message(), stackTrace: newTrace)
expectEqual(expected.isGE(), lhs >= rhs, message(), stackTrace: newTrace)
expectEqual(expected.isGT(), lhs > rhs, message(), stackTrace: newTrace)
checkComparable(expected, lhs, rhs, message(), stackTrace: newTrace)
}
FloatingPoint.test("${FloatSelf}/{Comparable,Hashable,Equatable}") {
// On arm we flush subnormals to zero so testing subnormals won't work.
#if arch(arm)
let interestingValues: [${FloatSelf}] = [
// Interesting floating point values, sorted.
-${FloatSelf}.infinity,
-${FloatSelf}.greatestFiniteMagnitude,
-1.0,
-${FloatSelf}.ulpOfOne,
-${FloatSelf}.leastNormalMagnitude,
-0.0,
0.0,
${FloatSelf}.leastNormalMagnitude,
${FloatSelf}.ulpOfOne,
1.0,
${FloatSelf}.greatestFiniteMagnitude,
${FloatSelf}.infinity,
${FloatSelf}.nan,
${FloatSelf}.signalingNaN,
]
#else
let interestingValues: [${FloatSelf}] = [
// Interesting floating point values, sorted.
-${FloatSelf}.infinity,
-${FloatSelf}.greatestFiniteMagnitude,
-1.0,
-${FloatSelf}.ulpOfOne,
-${FloatSelf}.leastNormalMagnitude,
-${FloatSelf}.leastNormalMagnitude/2,
-${FloatSelf}.leastNonzeroMagnitude,
-0.0,
0.0,
${FloatSelf}.leastNonzeroMagnitude,
${FloatSelf}.leastNormalMagnitude/2,
${FloatSelf}.leastNormalMagnitude,
${FloatSelf}.ulpOfOne,
1.0,
${FloatSelf}.greatestFiniteMagnitude,
${FloatSelf}.infinity,
${FloatSelf}.nan,
${FloatSelf}.signalingNaN,
]
#endif
for lhsIdx in interestingValues.indices {
for rhsIdx in interestingValues.indices {
let lhs = interestingValues[lhsIdx]
let rhs = interestingValues[rhsIdx]
if lhs.isZero && rhs.isZero {
// Special case: 0.0 and -0.0 compare equal.
checkFloatingPointComparison_${FloatSelf}(
ExpectedComparisonResult.eq, lhs, rhs)
} else if lhs.isNaN || rhs.isNaN {
// Special case: NaN is unordered wrt other values.
// - equality comparison with NaN returns false,
// - NaN is not equal to anything, including NaN.
expectFalse(lhs == rhs)
expectTrue(lhs != rhs)
expectFalse(lhs < rhs)
expectFalse(lhs <= rhs)
expectFalse(lhs >= rhs)
expectFalse(lhs > rhs)
} else {
// The sane case.
checkFloatingPointComparison_${FloatSelf}(
lhsIdx < rhsIdx ?
ExpectedComparisonResult.lt :
(lhsIdx == rhsIdx ?
ExpectedComparisonResult.eq :
ExpectedComparisonResult.gt),
lhs, rhs)
}
// Check minimum, maximum, minimumMagnitude and maximumMagnitude.
let min = ${FloatSelf}.minimum(lhs, rhs)
let max = ${FloatSelf}.maximum(lhs, rhs)
let minMag = ${FloatSelf}.minimumMagnitude(lhs, rhs)
let maxMag = ${FloatSelf}.maximumMagnitude(lhs, rhs)
// If either lhs or rhs is signaling, or if both are quiet NaNs, the
// result is a quiet NaN.
if lhs.isSignalingNaN || rhs.isSignalingNaN || (lhs.isNaN && rhs.isNaN) {
expectTrue(min.isQuietNaN)
expectTrue(max.isQuietNaN)
expectTrue(minMag.isQuietNaN)
expectTrue(maxMag.isQuietNaN)
}
// If only one of lhs and rhs is NaN, the result of the min/max
// operations is always the other value. While contrary to all other
// IEEE 754 basic operations, this property is critical to ensure
// that clamping to a valid range behaves as expected.
else if lhs.isNaN && !rhs.isNaN {
expectEqual(min.bitPattern, rhs.bitPattern)
expectEqual(max.bitPattern, rhs.bitPattern)
expectEqual(minMag.bitPattern, rhs.bitPattern)
expectEqual(maxMag.bitPattern, rhs.bitPattern)
}
else if rhs.isNaN && !lhs.isNaN {
expectEqual(min.bitPattern, lhs.bitPattern)
expectEqual(max.bitPattern, lhs.bitPattern)
expectEqual(minMag.bitPattern, lhs.bitPattern)
expectEqual(maxMag.bitPattern, lhs.bitPattern)
}
// If lhs and rhs are equal, min is lhs and max is rhs. This ensures
// that the set {lhs, rhs} is the same as the set {min, max} so long
// as lhs and rhs are non-NaN. This is less important for min/max than
// it is for minMag and maxMag, but it makes sense to define this way.
if lhs <= rhs {
expectEqual(min.bitPattern, lhs.bitPattern)
expectEqual(max.bitPattern, rhs.bitPattern)
} else if lhs > rhs {
expectEqual(max.bitPattern, lhs.bitPattern)
expectEqual(min.bitPattern, rhs.bitPattern)
}
// If lhs and rhs have equal magnitude, minMag is lhs and maxMag is rhs.
// This ensures that the set {lhs, rhs} is the same as the set
// {minMag, maxMag} so long as lhs and rhs are non-NaN; this is a
// restriction of the IEEE 754 rules, but it makes good sense and also
// makes this primitive more useful for building head-tail arithmetic
// operations.
if abs(lhs) <= abs(rhs) {
expectEqual(minMag.bitPattern, lhs.bitPattern)
expectEqual(maxMag.bitPattern, rhs.bitPattern)
} else if abs(lhs) > abs(rhs) {
expectEqual(maxMag.bitPattern, lhs.bitPattern)
expectEqual(minMag.bitPattern, rhs.bitPattern)
}
}
}
}
% end
% for Self in ['Float32', 'Float64', 'Float80']:
#if ${'!os(Windows) && (arch(i386) || arch(x86_64))' if Self == 'Float80' else 'true'}
FloatingPoint.test("${Self}/Strideable") {
// FIXME: the test data could probably be better chosen here, to
// exercise more cases. Note: NaNs (and possibly Infs) are singular
// values with respect to Strideable conformance and aren't expected
// to pass these tests.
let instances: [${Self}] = [-1.0, 0.0, 0.5, 1.0, 1E20]
checkStrideable(
instances, strides: instances,
distanceOracle: { instances[$1] - instances[$0] },
advanceOracle: { instances[$0] + instances[$1] })
}
#endif
% end
FloatingPoint.test("Float32/Literals") {
do {
let f: Float32 = 0.0
expectEqual(0x0000_0000, f.bitPattern)
}
do {
let f: Float32 = -0.0
expectEqual(0x8000_0000, f.bitPattern)
}
do {
let f: Float32 = 1.0
expectEqual(0x3f80_0000, f.bitPattern)
}
do {
let f: Float32 = -1.0
expectEqual(0xbf80_0000, f.bitPattern)
}
do {
let f: Float32 = 0.999999
expectEqual(0x3f7fffef, f.bitPattern)
}
do {
let f: Float32 = 0.9999999
expectEqual(0x3f7ffffe, f.bitPattern)
}
do {
let f: Float32 = 0.99999999
expectEqual(0x3f80_0000, f.bitPattern)
}
// Smallest subnormal.
do {
let f: Float32 = 1.4e-45
expectEqual(0x0000_0001, f.bitPattern)
}
do {
let f: Float32 = -1.4e-45
expectEqual(0x8000_0001, f.bitPattern)
}
// Rounded to zero.
do {
let f: Float32 = 0.7e-45
expectEqual(0x0000_0000, f.bitPattern)
}
do {
let f: Float32 = -0.7e-45
expectEqual(0x8000_0000, f.bitPattern)
}
// Second largest normal.
do {
let f: Float32 = 3.4028232e+38
expectEqual(0x7f7f_fffe, f.bitPattern)
}
do {
let f: Float32 = -3.4028232e+38
expectEqual(0xff7f_fffe, f.bitPattern)
}
// Largest normal.
do {
let f: Float32 = 3.4028234e+38
expectEqual(0x7f7f_ffff, f.bitPattern)
}
do {
let f: Float32 = 340282340000000000000000000000000000000.0
expectEqual(0x7f7f_ffff, f.bitPattern)
}
do {
let f: Float32 = 340282340000000000000000000000000000000
expectEqual(0x7f7f_ffff, f.bitPattern)
}
do {
let f: Float32 = -3.4028234e+38
expectEqual(0xff7f_ffff, f.bitPattern)
}
do {
let f: Float32 = -340282340000000000000000000000000000000.0
expectEqual(0xff7f_ffff, f.bitPattern)
}
do {
let f: Float32 = -340282340000000000000000000000000000000
expectEqual(0xff7f_ffff, f.bitPattern)
}
}
FloatingPoint.test("Float64/Literals") {
do {
let f: Float64 = 0.0
expectEqual(0x0000_0000_0000_0000, f.bitPattern)
}
do {
let f: Float64 = -0.0
expectEqual(0x8000_0000_0000_0000, f.bitPattern)
}
do {
let f: Float64 = 1.0
expectEqual(0x3ff0_0000_0000_0000, f.bitPattern)
}
do {
let f: Float64 = -1.0
expectEqual(0xbff0_0000_0000_0000, f.bitPattern)
}
do {
let f: Float64 = 0.999999999999999
expectEqual(0x3fef_ffff_ffff_fff7, f.bitPattern)
}
do {
let f: Float64 = 0.9999999999999999
expectEqual(0x3fef_ffff_ffff_ffff, f.bitPattern)
}
do {
let f: Float64 = 0.99999999999999999
expectEqual(0x3ff0_0000_0000_0000, f.bitPattern)
}
// Smallest subnormal.
do {
let f: Float64 = 4.0e-324
expectEqual(0x0000_0000_0000_0001, f.bitPattern)
}
do {
let f: Float64 = -4.0e-324
expectEqual(0x8000_0000_0000_0001, f.bitPattern)
}
// Rounded to zero.
do {
let f: Float64 = 2.4e-324
expectEqual(0x0000_0000_0000_0000, f.bitPattern)
}
do {
let f: Float64 = -2.4e-324
expectEqual(0x8000_0000_0000_0000, f.bitPattern)
}
// Second largest normal.
do {
let f: Float64 = 1.79769313486231551e+308
expectEqual(0x7fef_ffff_ffff_fffe, f.bitPattern)