Describe DECIMAL_DIG macro. Pretty print.
[kopensolaris-gnu/glibc.git] / math / math.h
1 /* Declarations for math functions.
2    Copyright (C) 1991, 92, 93, 95, 96, 97 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 /*
21  *      ISO C Standard: 4.5 MATHEMATICS <math.h>
22  */
23
24 #ifndef _MATH_H
25 #define _MATH_H 1
26
27 #include <features.h>
28
29 __BEGIN_DECLS
30
31 /* Get machine-dependent HUGE_VAL value (returned on overflow).
32    On all IEEE754 machines, this is +Infinity.  */
33 #include <bits/huge_val.h>
34
35 /* Get machine-dependent NAN value (returned for some domain errors).  */
36 #ifdef   __USE_GNU
37 # include <bits/nan.h>
38 #endif
39
40
41 /* The file <bits/mathcalls.h> contains the prototypes for all the
42    actual math functions.  These macros are used for those prototypes,
43    so we can easily declare each function as both `name' and `__name',
44    and can declare the float versions `namef' and `__namef'.  */
45
46 #define __MATHCALL(function,suffix, args)       \
47   __MATHDECL (_Mdouble_,function,suffix, args)
48 #define __MATHDECL(type, function,suffix, args) \
49   __MATHDECL_1(type, function,suffix, args); \
50   __MATHDECL_1(type, __CONCAT(__,function),suffix, args)
51 #define __MATHCALLX(function,suffix, args, attrib)      \
52   __MATHDECLX (_Mdouble_,function,suffix, args, attrib)
53 #define __MATHDECLX(type, function,suffix, args, attrib) \
54   __MATHDECL_1(type, function,suffix, args) __attribute__ (attrib); \
55   __MATHDECL_1(type, __CONCAT(__,function),suffix, args) __attribute__ (attrib)
56 #define __MATHDECL_1(type, function,suffix, args) \
57   extern type __MATH_PRECNAME(function,suffix) args
58
59 #define _Mdouble_               double
60 #define __MATH_PRECNAME(name,r) __CONCAT(name,r)
61 #include <bits/mathcalls.h>
62 #undef  _Mdouble_
63 #undef  __MATH_PRECNAME
64
65 #if defined __USE_MISC || defined __USE_ISOC9X
66
67
68 /* Include the file of declarations again, this time using `float'
69    instead of `double' and appending f to each function name.  */
70
71 # ifndef _Mfloat_
72 #  define _Mfloat_              float
73 # endif
74 # define _Mdouble_              _Mfloat_
75 # ifdef __STDC__
76 #  define __MATH_PRECNAME(name,r) name##f##r
77 # else
78 #  define __MATH_PRECNAME(name,r) name/**/f/**/r
79 # endif
80 # include <bits/mathcalls.h>
81 # undef _Mdouble_
82 # undef __MATH_PRECNAME
83
84 # if __STDC__ - 0 || __GNUC__ - 0
85 /* Include the file of declarations again, this time using `long double'
86    instead of `double' and appending l to each function name.  */
87
88 #  ifndef _Mlong_double_
89 #   define _Mlong_double_       long double
90 #  endif
91 #  define _Mdouble_             _Mlong_double_
92 #  ifdef __STDC__
93 #   define __MATH_PRECNAME(name,r) name##l##r
94 #  else
95 #   define __MATH_PRECNAME(name,r) name/**/l/**/r
96 #  endif
97 #  include <bits/mathcalls.h>
98 #  undef _Mdouble_
99 #  undef __MATH_PRECNAME
100
101 # endif /* __STDC__ || __GNUC__ */
102
103 #endif  /* Use misc or ISO C 9X.  */
104 #undef  __MATHDECL_1
105 #undef  __MATHDECL
106 #undef  __MATHCALL
107
108
109 #if defined __USE_MISC || defined __USE_XOPEN || defined __USE_ISOC9X
110 /* This variable is used by `gamma' and `lgamma'.  */
111 extern int signgam;
112 #endif
113
114
115 /* ISO C 9X defines some generic macros which work on any data type.  */
116 #if __USE_ISOC9X
117
118 /* Get the architecture specific values describing the floating-point
119    evaluation.  The following symbols will get defined:
120
121     float_t     floating-point type at least as wide as `float' used
122                 to evaluate `float' expressions
123     double_t    floating-point type at least as wide as `double' used
124                 to evaluate `double' expressions
125
126     FLT_EVAL_METHOD
127                 Defined to
128                   0     if `float_t' is `float' and `double_t' is `double'
129                   1     if `float_t' and `double_t' are `double'
130                   2     if `float_t' and `double_t' are `long double'
131                   else  `float_t' and `double_t' are unspecified
132
133     INFINITY    representation of the infinity value of type `float'
134
135     FP_FAST_FMA
136     FP_FAST_FMAF
137     FP_FAST_FMAL
138                 If defined it indicates that the the `fma' function
139                 generally executes about as fast as a multiply and an add.
140                 This macro is defined only iff the `fma' function is
141                 implemented directly with a hardware multiply-add instructions.
142
143     FP_ILOGB0   Expands to a value returned by `ilogb (0.0)'.
144     FP_ILOGBNAN Expands to a value returned by `ilogb (NAN)'.
145
146     DECIMAL_DIG Number of decimal digits supported by conversion between
147                 decimal and all internal floating-point formats.
148
149 */
150 # include <bits/mathdef.h>
151
152 /* All floating-point numbers can be put in one of these categories.  */
153 enum
154   {
155     FP_NAN,
156 # define FP_NAN FP_NAN
157     FP_INFINITE,
158 # define FP_INFINITE FP_INFINITE
159     FP_ZERO,
160 # define FP_ZERO FP_ZERO
161     FP_SUBNORMAL,
162 # define FP_SUBNORMAL FP_SUBNORMAL
163     FP_NORMAL
164 # define FP_NORMAL FP_NORMAL
165   };
166
167 /* Return number of classification appropriate for X.  */
168 # define fpclassify(x) \
169      (sizeof (x) == sizeof (float) ?                                          \
170         __fpclassifyf (x)                                                     \
171       : sizeof (x) == sizeof (double) ?                                       \
172         __fpclassify (x) : __fpclassifyl (x))
173
174 /* Return nonzero value if sign of X is negative.  */
175 # define signbit(x) \
176      (sizeof (x) == sizeof (float) ?                                          \
177         __signbitf (x)                                                        \
178       : sizeof (x) == sizeof (double) ?                                       \
179         __signbit (x) : __signbitl (x))
180
181 /* Return nonzero value if X is not +-Inf or NaN.  */
182 # define isfinite(x) \
183      (sizeof (x) == sizeof (float) ?                                          \
184         __finitef (x)                                                         \
185       : sizeof (x) == sizeof (double) ?                                       \
186         __finite (x) : __finitel (x))
187
188 /* Return nonzero value if X is neither zero, subnormal, Inf, nor NaN.  */
189 # define isnormal(x) (fpclassify (x) == FP_NORMAL)
190
191 /* Return nonzero value if X is a NaN.  We could use `fpclassify' but
192    we already have this functions `__isnan' and it is faster.  */
193 # define isnan(x) \
194      (sizeof (x) == sizeof (float) ?                                          \
195         __isnanf (x)                                                          \
196       : sizeof (x) == sizeof (double) ?                                       \
197         __isnan (x) : __isnanl (x))
198
199 #endif /* Use ISO C 9X.  */
200
201 #ifdef  __USE_MISC
202 /* Support for various different standard error handling behaviors.  */
203
204 typedef enum { _IEEE_ = -1, _SVID_, _XOPEN_, _POSIX_ } _LIB_VERSION_TYPE;
205
206 /* This variable can be changed at run-time to any of the values above to
207    affect floating point error handling behavior (it may also be necessary
208    to change the hardware FPU exception settings).  */
209 extern _LIB_VERSION_TYPE _LIB_VERSION;
210 #endif
211
212
213 #ifdef __USE_SVID
214 /* In SVID error handling, `matherr' is called with this description
215    of the exceptional condition.
216
217    We have a problem when using C++ since `exception' is a reserved
218    name in C++.  */
219 # ifdef __cplusplus
220 struct __exception
221 # else
222 struct exception
223 # endif
224   {
225     int type;
226     char *name;
227     double arg1;
228     double arg2;
229     double retval;
230   };
231
232 # ifdef __cplusplus
233 extern int __matherr __P ((struct __exception *__exc));
234 extern int matherr __P ((struct __exception *__exc));
235 # else
236 extern int __matherr __P ((struct exception *__exc));
237 extern int matherr __P ((struct exception *__exc));
238 # endif
239
240 # define X_TLOSS        1.41484755040568800000e+16
241
242 /* Types of exceptions in the `type' field.  */
243 # define DOMAIN         1
244 # define SING           2
245 # define OVERFLOW       3
246 # define UNDERFLOW      4
247 # define TLOSS          5
248 # define PLOSS          6
249
250 /* SVID mode specifies returning this large value instead of infinity.  */
251 # define HUGE           FLT_MAX
252 # include <float.h>             /* Defines FLT_MAX.  */
253
254 #else   /* !SVID */
255
256 # ifdef __USE_XOPEN
257 /* X/Open wants another strange constant.  */
258 #  define MAXFLOAT      FLT_MAX
259 #  include <float.h>
260 # endif
261
262 #endif  /* SVID */
263
264
265 #ifdef __USE_BSD
266
267 /* Some useful constants.  */
268 # define M_E            _Mldbl(2.7182818284590452354)   /* e */
269 # define M_LOG2E        _Mldbl(1.4426950408889634074)   /* log_2 e */
270 # define M_LOG10E       _Mldbl(0.43429448190325182765)  /* log_10 e */
271 # define M_LN2          _Mldbl(0.69314718055994530942)  /* log_e 2 */
272 # define M_LN10         _Mldbl(2.30258509299404568402)  /* log_e 10 */
273 # define M_PI           _Mldbl(3.14159265358979323846)  /* pi */
274 # define M_PI_2         _Mldbl(1.57079632679489661923)  /* pi/2 */
275 # define M_PI_4         _Mldbl(0.78539816339744830962)  /* pi/4 */
276 # define M_1_PI         _Mldbl(0.31830988618379067154)  /* 1/pi */
277 # define M_2_PI         _Mldbl(0.63661977236758134308)  /* 2/pi */
278 # define M_2_SQRTPI     _Mldbl(1.12837916709551257390)  /* 2/sqrt(pi) */
279 # define M_SQRT2        _Mldbl(1.41421356237309504880)  /* sqrt(2) */
280 # define M_SQRT1_2      _Mldbl(0.70710678118654752440)  /* 1/sqrt(2) */
281
282 #endif
283
284 /* Our constants might specify more precision than `double' can represent.
285    Use `long double' constants in standard and GNU C, where they are
286    supported and the cast to `double'.
287
288    If the constants are use in code which does not use prototypes, one
289    might get problems if a function takes a `double' argument and any
290    of the constants are provided as the argument.  In this case, cast
291    the argument to `double'.
292
293    Please note we define the macro even if the constants are not defined.
294    This helps us to use the macros in other places.  */
295 #if __STDC__ - 0 || __GNUC__ - 0
296 # define _Mldbl(x) x##L
297 #else   /* Traditional C.  */
298 # define _Mldbl(x) x
299 #endif  /* Standard or GNU C.  */
300
301
302 /* Get machine-dependent inline versions (if there are any).  */
303 #ifdef __OPTIMIZE__
304 # include <bits/mathinline.h>
305 #endif
306
307
308 #if __USE_ISOC9X
309 /* ISO C 9X defines some macros to compare number while taking care
310    for unordered numbers.  Since many FPUs provide special
311    instructions to support these operations and these tests are
312    defined in <bits/mathinline.h>, we define the generic macros at
313    this late point and only if they are not defined yet.  */
314
315 /* Return nonzero value if X is greater than Y.  */
316 # ifndef isgreater
317 #  define isgreater(x, y) \
318   (__extension__                                                              \
319    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
320       !isunordered (__x, __y) && __x > __y; }))
321 # endif
322
323 /* Return nonzero value if X is greater than or equal to Y.  */
324 # ifndef isgreaterequal
325 #  define isgreaterequal(x, y) \
326   (__extension__                                                              \
327    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
328       !isunordered (__x, __y) && __x >= __y; }))
329 # endif
330
331 /* Return nonzero value if X is less than Y.  */
332 # ifndef isless
333 #  define isless(x, y) \
334   (__extension__                                                              \
335    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
336       !isunordered (__x, __y) && __x < __y; }))
337 # endif
338
339 /* Return nonzero value if X is less than or equal to Y.  */
340 # ifndef islessequal
341 #  define islessequal(x, y) \
342   (__extension__                                                              \
343    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
344       !isunordered (__x, __y) && __x <= __y; }))
345 # endif
346
347 /* Return nonzero value if either X is less than Y or Y is less than X.  */
348 # ifndef islessgreater
349 #  define islessgreater(x, y) \
350   (__extension__                                                              \
351    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
352       !isunordered (__x, __y) && (__x < __y || __y < __x); }))
353 # endif
354
355 /* Return nonzero value if arguments are unordered.  */
356 # ifndef isunordered
357 #  define isunordered(x, y) \
358   (__extension__                                                              \
359    ({ __typeof__(x) __x = (x); __typeof__(y) __y = (y);                       \
360       fpclassify (__x) == FP_NAN || fpclassify (__y) == FP_NAN; }))
361 # endif
362
363 #endif
364
365 __END_DECLS
366
367
368 #endif /* math.h  */