]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - lib/msun/src/s_csqrtl.c
Fix scaling bugs which gave innaccuracies and spurious underflows in csqrt()
[FreeBSD/FreeBSD.git] / lib / msun / src / s_csqrtl.c
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2007-2008 David Schultz <das@FreeBSD.ORG>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31
32 #include <complex.h>
33 #include <float.h>
34 #include <math.h>
35
36 #include "math_private.h"
37
38 /*
39  * gcc doesn't implement complex multiplication or division correctly,
40  * so we need to handle infinities specially. We turn on this pragma to
41  * notify conforming c99 compilers that the fast-but-incorrect code that
42  * gcc generates is acceptable, since the special cases have already been
43  * handled.
44  */
45 #pragma STDC CX_LIMITED_RANGE   ON
46
47 /*
48  * We risk spurious overflow for components >= LDBL_MAX / (1 + sqrt(2)).
49  * Rather than determining the fully precise value at which we might
50  * overflow, just use a threshold of approximately LDBL_MAX / 4.
51  */
52 #if LDBL_MAX_EXP != 0x4000
53 #error "Unsupported long double format"
54 #else
55 #define THRESH  0x1p16382L
56 #endif
57
58 long double complex
59 csqrtl(long double complex z)
60 {
61         long double complex result;
62         long double a, b, rx, ry, scale, t;
63
64         a = creall(z);
65         b = cimagl(z);
66
67         /* Handle special cases. */
68         if (z == 0)
69                 return (CMPLXL(0, b));
70         if (isinf(b))
71                 return (CMPLXL(INFINITY, b));
72         if (isnan(a)) {
73                 t = (b - b) / (b - b);  /* raise invalid if b is not a NaN */
74                 return (CMPLXL(a + 0.0L + t, a + 0.0L + t)); /* NaN + NaN i */
75         }
76         if (isinf(a)) {
77                 /*
78                  * csqrt(inf + NaN i)  = inf +  NaN i
79                  * csqrt(inf + y i)    = inf +  0 i
80                  * csqrt(-inf + NaN i) = NaN +- inf i
81                  * csqrt(-inf + y i)   = 0   +  inf i
82                  */
83                 if (signbit(a))
84                         return (CMPLXL(fabsl(b - b), copysignl(a, b)));
85                 else
86                         return (CMPLXL(a, copysignl(b - b, b)));
87         }
88         if (isnan(b)) {
89                 t = (a - a) / (a - a);  /* raise invalid */
90                 return (CMPLXL(b + 0.0L + t, b + 0.0L + t)); /* NaN + NaN i */
91         }
92
93         /* Scale to avoid overflow. */
94         if (fabsl(a) >= THRESH || fabsl(b) >= THRESH) {
95                 /*
96                  * Don't scale a or b if this might give (spurious)
97                  * underflow.  Then the unscaled value is an equivalent
98                  * infinitesmal (or 0).
99                  */
100                 if (fabsl(a) >= 0x1p-16380L)
101                         a *= 0.25;
102                 if (fabsl(b) >= 0x1p-16380L)
103                         b *= 0.25;
104                 scale = 2;
105         } else {
106                 scale = 1;
107         }
108
109         /* Scale to reduce inaccuracies when both components are denormal. */
110         if (fabsl(a) < 0x1p-16382L && fabsl(b) < 0x1p-16382L) {
111                 a *= 0x1p64;
112                 b *= 0x1p64;
113                 scale = 0x1p-32;
114         }
115
116         /* Algorithm 312, CACM vol 10, Oct 1967. */
117         if (a >= 0) {
118                 t = sqrtl((a + hypotl(a, b)) * 0.5);
119                 rx = t;
120                 ry = b / (2 * t);
121         } else {
122                 t = sqrtl((-a + hypotl(a, b)) * 0.5);
123                 rx = fabsl(b) / (2 * t);
124                 ry = copysignl(t, b);
125         }
126
127         return (CMPLXL(rx * scale, ry * scale));
128 }