ada: Allow use of writable parameters inside function with side-effects
[official-gcc.git] / libquadmath / quadmath.h
blob81eb957d2faa8373d26e9359a6f0ffbd4e5f9763
1 /* GCC Quad-Precision Math Library
2 Copyright (C) 2010-2019 Free Software Foundation, Inc.
3 Written by Francois-Xavier Coudert <fxcoudert@gcc.gnu.org>
5 This file is part of the libquadmath library.
6 Libquadmath is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
11 Libquadmath is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
16 You should have received a copy of the GNU Library General Public
17 License along with libquadmath; see the file COPYING.LIB. If
18 not, write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
19 Boston, MA 02110-1301, USA. */
21 #ifndef QUADMATH_H
22 #define QUADMATH_H
24 #include <stdlib.h>
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
30 /* Define the complex type corresponding to __float128
31 ("_Complex __float128" is not allowed) */
32 #if (!defined(_ARCH_PPC)) || defined(__LONG_DOUBLE_IEEE128__)
33 typedef _Complex float __attribute__((mode(TC))) __complex128;
34 #else
35 typedef _Complex float __attribute__((mode(KC))) __complex128;
36 #endif
38 #ifdef __cplusplus
39 # define __quadmath_throw throw ()
40 # define __quadmath_nth(fct) fct throw ()
41 #else
42 # define __quadmath_throw __attribute__((__nothrow__))
43 # define __quadmath_nth(fct) __attribute__((__nothrow__)) fct
44 #endif
46 /* Prototypes for real functions */
47 extern __float128 acosq (__float128) __quadmath_throw;
48 extern __float128 acoshq (__float128) __quadmath_throw;
49 extern __float128 asinq (__float128) __quadmath_throw;
50 extern __float128 asinhq (__float128) __quadmath_throw;
51 extern __float128 atanq (__float128) __quadmath_throw;
52 extern __float128 atanhq (__float128) __quadmath_throw;
53 extern __float128 atan2q (__float128, __float128) __quadmath_throw;
54 extern __float128 cbrtq (__float128) __quadmath_throw;
55 extern __float128 ceilq (__float128) __quadmath_throw;
56 extern __float128 copysignq (__float128, __float128) __quadmath_throw;
57 extern __float128 coshq (__float128) __quadmath_throw;
58 extern __float128 cosq (__float128) __quadmath_throw;
59 extern __float128 erfq (__float128) __quadmath_throw;
60 extern __float128 erfcq (__float128) __quadmath_throw;
61 extern __float128 exp2q (__float128) __quadmath_throw;
62 extern __float128 expq (__float128) __quadmath_throw;
63 extern __float128 expm1q (__float128) __quadmath_throw;
64 extern __float128 fabsq (__float128) __quadmath_throw;
65 extern __float128 fdimq (__float128, __float128) __quadmath_throw;
66 extern int finiteq (__float128) __quadmath_throw;
67 extern __float128 floorq (__float128) __quadmath_throw;
68 extern __float128 fmaq (__float128, __float128, __float128) __quadmath_throw;
69 extern __float128 fmaxq (__float128, __float128) __quadmath_throw;
70 extern __float128 fminq (__float128, __float128) __quadmath_throw;
71 extern __float128 fmodq (__float128, __float128) __quadmath_throw;
72 extern __float128 frexpq (__float128, int *) __quadmath_throw;
73 extern __float128 hypotq (__float128, __float128) __quadmath_throw;
74 extern int isinfq (__float128) __quadmath_throw;
75 extern int ilogbq (__float128) __quadmath_throw;
76 extern int isnanq (__float128) __quadmath_throw;
77 extern int issignalingq (__float128) __quadmath_throw;
78 extern __float128 j0q (__float128) __quadmath_throw;
79 extern __float128 j1q (__float128) __quadmath_throw;
80 extern __float128 jnq (int, __float128) __quadmath_throw;
81 extern __float128 ldexpq (__float128, int) __quadmath_throw;
82 extern __float128 lgammaq (__float128) __quadmath_throw;
83 extern long long int llrintq (__float128) __quadmath_throw;
84 extern long long int llroundq (__float128) __quadmath_throw;
85 extern __float128 logbq (__float128) __quadmath_throw;
86 extern __float128 logq (__float128) __quadmath_throw;
87 extern __float128 log10q (__float128) __quadmath_throw;
88 extern __float128 log2q (__float128) __quadmath_throw;
89 extern __float128 log1pq (__float128) __quadmath_throw;
90 extern long int lrintq (__float128) __quadmath_throw;
91 extern long int lroundq (__float128) __quadmath_throw;
92 extern __float128 modfq (__float128, __float128 *) __quadmath_throw;
93 extern __float128 nanq (const char *) __quadmath_throw;
94 extern __float128 nearbyintq (__float128) __quadmath_throw;
95 extern __float128 nextafterq (__float128, __float128) __quadmath_throw;
96 extern __float128 powq (__float128, __float128) __quadmath_throw;
97 extern __float128 remainderq (__float128, __float128) __quadmath_throw;
98 extern __float128 remquoq (__float128, __float128, int *) __quadmath_throw;
99 extern __float128 rintq (__float128) __quadmath_throw;
100 extern __float128 roundq (__float128) __quadmath_throw;
101 extern __float128 scalblnq (__float128, long int) __quadmath_throw;
102 extern __float128 scalbnq (__float128, int) __quadmath_throw;
103 extern int signbitq (__float128) __quadmath_throw;
104 extern void sincosq (__float128, __float128 *, __float128 *) __quadmath_throw;
105 extern __float128 sinhq (__float128) __quadmath_throw;
106 extern __float128 sinq (__float128) __quadmath_throw;
107 extern __float128 sqrtq (__float128) __quadmath_throw;
108 extern __float128 tanq (__float128) __quadmath_throw;
109 extern __float128 tanhq (__float128) __quadmath_throw;
110 extern __float128 tgammaq (__float128) __quadmath_throw;
111 extern __float128 truncq (__float128) __quadmath_throw;
112 extern __float128 y0q (__float128) __quadmath_throw;
113 extern __float128 y1q (__float128) __quadmath_throw;
114 extern __float128 ynq (int, __float128) __quadmath_throw;
117 /* Prototypes for complex functions */
118 extern __float128 cabsq (__complex128) __quadmath_throw;
119 extern __float128 cargq (__complex128) __quadmath_throw;
120 extern __float128 cimagq (__complex128) __quadmath_throw;
121 extern __float128 crealq (__complex128) __quadmath_throw;
122 extern __complex128 cacosq (__complex128) __quadmath_throw;
123 extern __complex128 cacoshq (__complex128) __quadmath_throw;
124 extern __complex128 casinq (__complex128) __quadmath_throw;
125 extern __complex128 casinhq (__complex128) __quadmath_throw;
126 extern __complex128 catanq (__complex128) __quadmath_throw;
127 extern __complex128 catanhq (__complex128) __quadmath_throw;
128 extern __complex128 ccosq (__complex128) __quadmath_throw;
129 extern __complex128 ccoshq (__complex128) __quadmath_throw;
130 extern __complex128 cexpq (__complex128) __quadmath_throw;
131 extern __complex128 cexpiq (__float128) __quadmath_throw;
132 extern __complex128 clogq (__complex128) __quadmath_throw;
133 extern __complex128 clog10q (__complex128) __quadmath_throw;
134 extern __complex128 conjq (__complex128) __quadmath_throw;
135 extern __complex128 cpowq (__complex128, __complex128) __quadmath_throw;
136 extern __complex128 cprojq (__complex128) __quadmath_throw;
137 extern __complex128 csinq (__complex128) __quadmath_throw;
138 extern __complex128 csinhq (__complex128) __quadmath_throw;
139 extern __complex128 csqrtq (__complex128) __quadmath_throw;
140 extern __complex128 ctanq (__complex128) __quadmath_throw;
141 extern __complex128 ctanhq (__complex128) __quadmath_throw;
144 /* Prototypes for string <-> __float128 conversion functions */
145 extern __float128 strtoflt128 (const char *, char **) __quadmath_throw;
146 extern int quadmath_snprintf (char *str, size_t size,
147 const char *format, ...) __quadmath_throw;
150 /* Macros */
151 #define FLT128_MAX 1.18973149535723176508575932662800702e4932Q
152 #define FLT128_MIN 3.36210314311209350626267781732175260e-4932Q
153 #define FLT128_EPSILON 1.92592994438723585305597794258492732e-34Q
154 #define FLT128_DENORM_MIN 6.475175119438025110924438958227646552e-4966Q
155 #define FLT128_MANT_DIG 113
156 #define FLT128_MIN_EXP (-16381)
157 #define FLT128_MAX_EXP 16384
158 #define FLT128_DIG 33
159 #define FLT128_MIN_10_EXP (-4931)
160 #define FLT128_MAX_10_EXP 4932
163 #define HUGE_VALQ __builtin_huge_valq()
164 /* The following alternative is valid, but brings the warning:
165 (floating constant exceeds range of ‘__float128’) */
166 /* #define HUGE_VALQ (__extension__ 0x1.0p32767Q) */
168 #define M_Eq 2.718281828459045235360287471352662498Q /* e */
169 #define M_LOG2Eq 1.442695040888963407359924681001892137Q /* log_2 e */
170 #define M_LOG10Eq 0.434294481903251827651128918916605082Q /* log_10 e */
171 #define M_LN2q 0.693147180559945309417232121458176568Q /* log_e 2 */
172 #define M_LN10q 2.302585092994045684017991454684364208Q /* log_e 10 */
173 #define M_PIq 3.141592653589793238462643383279502884Q /* pi */
174 #define M_PI_2q 1.570796326794896619231321691639751442Q /* pi/2 */
175 #define M_PI_4q 0.785398163397448309615660845819875721Q /* pi/4 */
176 #define M_1_PIq 0.318309886183790671537767526745028724Q /* 1/pi */
177 #define M_2_PIq 0.636619772367581343075535053490057448Q /* 2/pi */
178 #define M_2_SQRTPIq 1.128379167095512573896158903121545172Q /* 2/sqrt(pi) */
179 #define M_SQRT2q 1.414213562373095048801688724209698079Q /* sqrt(2) */
180 #define M_SQRT1_2q 0.707106781186547524400844362104849039Q /* 1/sqrt(2) */
182 #define __quadmath_extern_inline \
183 extern inline __attribute__ ((__gnu_inline__))
185 __quadmath_extern_inline __float128
186 __quadmath_nth (cimagq (__complex128 __z))
188 return __imag__ __z;
191 __quadmath_extern_inline __float128
192 __quadmath_nth (crealq (__complex128 __z))
194 return __real__ __z;
197 __quadmath_extern_inline __complex128
198 __quadmath_nth (conjq (__complex128 __z))
200 return __extension__ ~__z;
203 #ifdef __cplusplus
205 #endif
207 #endif