xref: /openbsd-src/gnu/usr.bin/perl/ext/POSIX/t/math.t (revision be691f3bb6417f04a68938fadbcaee2d5795e764)
1#!perl -w
2
3use strict;
4
5use POSIX ':math_h_c99';
6use POSIX ':nan_payload';
7use Test::More;
8
9use Config;
10
11# These tests are mainly to make sure that these arithmetic functions
12# exist and are accessible.  They are not meant to be an exhaustive
13# test for the interface.
14
15sub between {
16    my ($low, $have, $high, $desc) = @_;
17    local $Test::Builder::Level = $Test::Builder::Level + 1;
18
19    cmp_ok($have, '>=', $low, $desc);
20    cmp_ok($have, '<=', $high, $desc);
21}
22
23is(acos(1), 0, "Basic acos(1) test");
24between(3.14, acos(-1), 3.15, 'acos(-1)');
25between(1.57, acos(0), 1.58, 'acos(0)');
26is(asin(0), 0, "Basic asin(0) test");
27cmp_ok(asin(1), '>', 1.57, "Basic asin(1) test");
28cmp_ok(asin(-1), '<', -1.57, "Basic asin(-1) test");
29cmp_ok(asin(1), '==', -asin(-1), 'asin(1) == -asin(-1)');
30is(atan(0), 0, "Basic atan(0) test");
31between(0.785, atan(1), 0.786, 'atan(1)');
32between(-0.786, atan(-1), -0.785, 'atan(-1)');
33cmp_ok(atan(1), '==', -atan(-1), 'atan(1) == -atan(-1)');
34is(cosh(0), 1, "Basic cosh(0) test");
35between(1.54, cosh(1), 1.55, 'cosh(1)');
36between(1.54, cosh(-1), 1.55, 'cosh(-1)');
37is(cosh(1), cosh(-1), 'cosh(1) == cosh(-1)');
38is(floor(1.23441242), 1, "Basic floor(1.23441242) test");
39is(floor(-1.23441242), -2, "Basic floor(-1.23441242) test");
40is(fmod(3.5, 2.0), 1.5, "Basic fmod(3.5, 2.0) test");
41is(join(" ", frexp(1)), "0.5 1",  "Basic frexp(1) test");
42is(ldexp(0,1), 0, "Basic ldexp(0,1) test");
43is(log10(1), 0, "Basic log10(1) test");
44is(log10(10), 1, "Basic log10(10) test");
45is(join(" ", modf(1.76)), "0.76 1", "Basic modf(1.76) test");
46is(sinh(0), 0, "Basic sinh(0) test");
47between(1.17, sinh(1), 1.18, 'sinh(1)');
48between(-1.18, sinh(-1), -1.17, 'sinh(-1)');
49is(tan(0), 0, "Basic tan(0) test");
50between(1.55, tan(1), 1.56, 'tan(1)');
51between(1.55, tan(1), 1.56, 'tan(-1)');
52cmp_ok(tan(1), '==', -tan(-1), 'tan(1) == -tan(-1)');
53is(tanh(0), 0, "Basic tanh(0) test");
54between(0.76, tanh(1), 0.77, 'tanh(1)');
55between(-0.77, tanh(-1), -0.76, 'tanh(-1)');
56cmp_ok(tanh(1), '==', -tanh(-1), 'tanh(1) == -tanh(-1)');
57
58SKIP: {
59    skip "no fpclassify", 4 unless $Config{d_fpclassify};
60    is(fpclassify(1), FP_NORMAL, "fpclassify 1");
61    is(fpclassify(0), FP_ZERO, "fpclassify 0");
62    SKIP: {
63        skip("no inf", 1) unless $Config{d_double_has_inf};
64        is(fpclassify(INFINITY), FP_INFINITE, "fpclassify INFINITY");
65    }
66    SKIP: {
67        skip("no nan", 1) unless $Config{d_double_has_nan};
68        is(fpclassify(NAN), FP_NAN, "fpclassify NAN");
69    }
70}
71
72sub near {
73    my ($got, $want, $msg, $eps) = @_;
74    $eps ||= 1e-6;
75    cmp_ok(abs($got - $want), '<', $eps, $msg);
76}
77
78SKIP: {
79
80    unless ($Config{d_acosh}) {
81        skip "no acosh, suspecting no C99 math";
82    }
83    if ($^O =~ /VMS/) {
84        skip "running in $^O, C99 math support uneven";
85    }
86    if ($Config{cc} =~ /\b(?:cl|icl)/) {
87        skip "Microsoft compiler - C99 math support uneven";
88    }
89
90    near(M_SQRT2, 1.4142135623731, "M_SQRT2", 1e-9);
91    near(M_E, 2.71828182845905, "M_E", 1e-9);
92    near(M_PI, 3.14159265358979, "M_PI", 1e-9);
93    near(acosh(2), 1.31695789692482, "acosh", 1e-9);
94    near(asinh(1), 0.881373587019543, "asinh", 1e-9);
95    near(atanh(0.5), 0.549306144334055, "atanh", 1e-9);
96    near(cbrt(8), 2, "cbrt", 1e-9);
97    near(cbrt(-27), -3, "cbrt", 1e-9);
98    near(copysign(3.14, -2), -3.14, "copysign", 1e-9);
99    near(expm1(2), 6.38905609893065, "expm1", 1e-9);
100    near(expm1(1e-6), 1.00000050000017e-06, "expm1", 1e-9);
101    is(fdim(12, 34), 0, "fdim 12 34");
102    is(fdim(34, 12), 22, "fdim 34 12");
103    is(fmax(12, 34), 34, "fmax 12 34");
104    is(fmin(12, 34), 12, "fmin 12 34");
105    is(hypot(3, 4), 5, "hypot 3 4");
106    near(hypot(-2, 1), sqrt(5), "hypot -1 2", 1e-9);
107    is(ilogb(255), 7, "ilogb 255");
108    is(ilogb(256), 8, "ilogb 256");
109    ok(isfinite(1), "isfinite 1");
110    ok(!isinf(42), "isinf 42");
111    ok(!isnan(42), "isnan Inf");
112  SKIP: {
113      skip("no inf", 4) unless $Config{d_double_has_inf};
114      ok(!isfinite(Inf), "isfinite Inf");
115      ok(isinf(INFINITY), "isinf INFINITY");
116      ok(isinf(Inf), "isinf Inf");
117      ok(!isnan(Inf), "isnan Inf");
118    }
119  SKIP: {
120      skip("no nan", 5) unless $Config{d_double_has_nan};
121      ok(!isfinite(NaN), "isfinite NaN");
122      ok(!isinf(NaN), "isinf NaN");
123      ok(isnan(NAN), "isnan NAN");
124      ok(isnan(NaN), "isnan NaN");
125      cmp_ok(nan(), '!=', nan(), 'nan');
126    }
127    near(log1p(2), 1.09861228866811, "log1p", 1e-9);
128    near(log1p(1e-6), 9.99999500000333e-07, "log1p", 1e-9);
129    near(log2(8), 3, "log2", 1e-9);
130    is(signbit(2), 0, "signbit 2"); # zero
131    ok(signbit(-2), "signbit -2"); # non-zero
132    is(signbit(0), 0, "signbit 0"); # zero
133    is(signbit(0.5), 0, "signbit 0.5"); # zero
134    ok(signbit(-0.5), "signbit -0.5"); # non-zero
135    is(round(2.25), 2, "round 2.25");
136    is(round(-2.25), -2, "round -2.25");
137    is(round(2.5), 3, "round 2.5");
138    is(round(-2.5), -3, "round -2.5");
139    is(round(2.75), 3, "round 2.75");
140    is(round(-2.75), -3, "round 2.75");
141    is(lround(-2.75), -3, "lround -2.75");
142    is(lround(-0.25), 0, "lround -0.25");
143    is(lround(-0.50), -1, "lround -0.50");
144    is(signbit(lround(-0.25)), 0, "signbit lround -0.25 zero");
145    ok(signbit(lround(-0.50)), "signbit lround -0.50 non-zero"); # non-zero
146    is(trunc(2.25), 2, "trunc 2.25");
147    is(trunc(-2.25), -2, "trunc -2.25");
148    is(trunc(2.5), 2, "trunc 2.5");
149    is(trunc(-2.5), -2, "trunc -2.5");
150    is(trunc(2.75), 2, "trunc 2.75");
151    is(trunc(-2.75), -2, "trunc -2.75");
152    ok(isless(1, 2), "isless 1 2");
153    ok(!isless(2, 1), "isless 2 1");
154    ok(!isless(1, 1), "isless 1 1");
155    ok(isgreater(2, 1), "isgreater 2 1");
156    ok(islessequal(1, 1), "islessequal 1 1");
157
158  SKIP: {
159      skip("no nan", 2) unless $Config{d_double_has_nan};
160      ok(!isless(1, NaN), "isless 1 NaN");
161      ok(isunordered(1, NaN), "isunordered 1 NaN");
162    }
163
164    near(erf(0.5), 0.520499877813047, "erf 0.5", 1.5e-7);
165    near(erf(1), 0.842700792949715, "erf 1", 1.5e-7);
166    near(erf(9), 1, "erf 9", 1.5e-7);
167    near(erfc(0.5), 0.479500122186953, "erfc 0.5", 1.5e-7);
168    near(erfc(1), 0.157299207050285, "erfc 1", 1.5e-7);
169    near(erfc(9), 0, "erfc 9", 1.5e-7);
170
171    # tgamma(n) = (n - 1)!
172    # lgamma(n) = log(tgamma(n))
173    near(tgamma(5), 24, "tgamma 5", 1.5e-7);
174    near(tgamma(5.5), 52.3427777845535, "tgamma 5.5", 1.5e-7);
175    near(tgamma(9), 40320, "tgamma 9", 1.5e-7);
176    near(lgamma(5), 3.17805383034795, "lgamma 4", 1.5e-7);
177    near(lgamma(5.5), 3.95781396761872, "lgamma 5.5", 1.5e-7);
178    near(lgamma(9), 10.6046029027452, "lgamma 9", 1.5e-7);
179
180  SKIP: {
181      skip("no inf/nan", 19) unless $Config{d_double_has_inf} && $Config{d_double_has_nan};
182
183      # These don't work on old mips/hppa platforms
184      # because nan with payload zero == Inf (or == -Inf).
185      # ok(isnan(setpayload(0)), "setpayload zero");
186      # is(getpayload(setpayload(0)), 0, "setpayload + getpayload (zero)");
187      #
188      # These don't work on most platforms because == Inf (or == -Inf).
189      # ok(isnan(setpayloadsig(0)), "setpayload zero");
190      # is(getpayload(setpayloadsig(0)), 0, "setpayload + getpayload (zero)");
191
192      # Verify that the payload set be setpayload()
193      # (1) still is a nan
194      # (2) but the payload can be retrieved
195      # (3) but is not signaling
196      my $x = 0;
197      setpayload($x, 0x12345);
198      ok(isnan($x), "setpayload + isnan");
199      is(getpayload($x), 0x12345, "setpayload + getpayload");
200      ok(!issignaling($x), "setpayload + issignaling");
201
202      # Verify that the signaling payload set be setpayloadsig()
203      # (1) still is a nan
204      # (2) but the payload can be retrieved
205      # (3) and is signaling
206      setpayloadsig($x, 0x12345);
207      ok(isnan($x), "setpayloadsig + isnan");
208      is(getpayload($x), 0x12345, "setpayloadsig + getpayload");
209    SKIP: {
210        # https://rt.perl.org/Ticket/Display.html?id=125710
211        # In the 32-bit x86 ABI cannot preserve the signaling bit
212        # (the x87 simply does not preserve that).  But using the
213        # 80-bit extended format aka long double, the bit is preserved.
214        # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=57484
215        my $could_be_x86_32 =
216            # This is a really weak test: there are other 32-bit
217            # little-endian platforms than just Intel (some embedded
218            # processors, for example), but we use this just for not
219            # bothering with the test if things look iffy.
220            # We could, say, $Config{ccsymbols} =~ /\b__[xi][3-7]86=1\b/,
221            # but that feels quite shaky.
222            $Config{byteorder} =~ /1234/ &&
223            $Config{longdblkind} == 3 &&
224            $Config{ptrsize} == 4;
225        skip($^O, 1) if $could_be_x86_32 && !$Config{uselongdouble};
226        ok(issignaling($x), "setpayloadsig + issignaling");
227      }
228
229      # Try a payload more than one byte.
230      is(getpayload(nan(0x12345)), 0x12345, "nan + getpayload");
231
232      # Try payloads of 2^k, most importantly at and beyond 2^32.  These
233      # tests will fail if NV is just 32-bit float, but that Should Not
234      # Happen (tm).
235      is(getpayload(nan(2**31)), 2**31, "nan + getpayload 2**31");
236      is(getpayload(nan(2**32)), 2**32, "nan + getpayload 2**32");
237      is(getpayload(nan(2**33)), 2**33, "nan + getpayload 2**33");
238
239      # Payloads just lower than 2^k.
240      is(getpayload(nan(2**31-1)), 2**31-1, "nan + getpayload 2**31-1");
241      is(getpayload(nan(2**32-1)), 2**32-1, "nan + getpayload 2**32-1");
242
243      # Payloads not divisible by two (and larger than 2**32).
244
245    SKIP: {
246        # solaris gets 10460353202 from getpayload() when it should
247        # get 10460353203 (the 3**21). Things go wrong already in
248        # the nan() payload setting: [0x2, 0x6f7c52b4] (ivsize=4)
249        # instead [0x2, 0x6f7c52b3].  Then at getpayload() things
250        # go wrong again, now in other direction: with the (wrong)
251        # [0x2, 0x6f7c52b4] encoded in the nan we should decode into
252        # 10460353204, but we get 10460353202.  It doesn't seem to
253        # help even if we use 'unsigned long long' instead of UV/U32
254        # in the POSIX.xs:S_setpayload/S_getpayload.
255        #
256        # casting bug?  fmod() bug?  Though also broken with
257        # -Duselongdouble + fmodl(), so maybe Solaris cc bug
258        # in general?
259        #
260        # Ironically, the large prime seems to work even in Solaris,
261        # probably just by blind luck.
262        skip($^O, 1) if $^O eq 'solaris';
263        is(getpayload(nan(3**21)), 3**21, "nan + getpayload 3**21");
264      }
265      is(getpayload(nan(4294967311)), 4294967311, "nan + getpayload prime");
266
267      # Truncates towards zero.
268      is(getpayload(nan(1234.567)), 1234, "nan (trunc) + getpayload");
269
270      # Not signaling.
271      ok(!issignaling(0), "issignaling zero");
272      ok(!issignaling(+Inf), "issignaling +Inf");
273      ok(!issignaling(-Inf), "issignaling -Inf");
274      ok(!issignaling(NaN), "issignaling NaN");
275    }
276} # SKIP
277
278done_testing();
279