Sat Jun 15 18:13:43 1996 Roland McGrath <roland@delasyd.gnu.ai.mit.edu>
[kopensolaris-gnu/glibc.git] / math / math.h
1 /* Declarations for math functions.
2 Copyright (C) 1991, 92, 93, 95, 96 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
17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
18 Cambridge, MA 02139, USA.  */
19
20 /*
21  *      ANSI Standard: 4.5 MATHEMATICS  <math.h>
22  */
23
24 #ifndef _MATH_H
25
26 #define _MATH_H 1
27 #include <features.h>
28
29 __BEGIN_DECLS
30
31 #define __need_Emath
32 #include <errno.h>
33
34 /* Get machine-dependent HUGE_VAL value (returned on overflow).
35    On all IEEE754 machines, this is +Infinity.  */
36 #include <huge_val.h>
37
38 /* Get machine-dependent NAN value (returned for some domain errors).  */
39 #ifdef   __USE_GNU
40 #include <nan.h>
41 #endif
42
43
44 /* The file <mathcalls.h> contains the prototypes for all the actual
45    math functions.  These macros are used for those prototypes, so
46    we can easily declare each function as both `name' and `__name',
47    and can declare the float versions `namef' and `__namef'.  */
48
49 #define __MATHCALL(function,suffix, args)       \
50   __MATHDECL (_Mdouble_, function,suffix, args)
51 #define __MATHDECL(type, function,suffix, args) \
52   __MATHDECL_1(type, function,suffix, args); \
53   __MATHDECL_1(type, __##function,suffix, args)
54 #define __MATHDECL_1(type, function,suffix, args) \
55   extern type __MATH_PRECNAME(function,suffix) args
56
57 #define _Mdouble_               double
58 #define __MATH_PRECNAME(name,r) name##r
59 #include <mathcalls.h>
60 #undef  _Mdouble_
61 #undef  __MATH_PRECNAME
62
63 #ifdef __USE_MISC
64
65 /* Include the file of declarations again, this type using `float'
66    instead of `double' and appending f to each function name.  */
67
68 #define _Mdouble_               float
69 #define __MATH_PRECNAME(name,r) name##f##r
70 #include <mathcalls.h>
71 #undef  _Mdouble_
72 #undef  __MATH_PRECNAME
73
74 /* Include the file of declarations again, this type using `long double'
75    instead of `double' and appending l to each function name.  */
76
77 #define _Mdouble_               long double
78 #define __MATH_PRECNAME(name,r) name##l##r
79 #include <mathcalls.h>
80 #undef  _Mdouble_
81 #undef  __MATH_PRECNAME
82
83 #endif  /* Use misc.  */
84
85
86 #ifdef  __USE_MISC
87 /* Support for various different standard error handling behaviors.  */
88
89 typedef enum { _IEEE_ = -1, _SVID_, _XOPEN_, _POSIX_ } _LIB_VERSION_TYPE;
90
91 /* This variable can be changed at run-time to any of the values above to
92    affect floating point error handling behavior (it may also be necessary
93    to change the hardware FPU exception settings).  */
94 extern _LIB_VERSION_TYPE _LIB_VERSION;
95 #endif
96
97
98 #ifdef __USE_SVID
99 /* In SVID error handling, `matherr' is called with this description
100    of the exceptional condition.  */
101 struct exception
102   {
103     int type;
104     char *name;
105     double arg1;
106     double arg2;
107     double retval;
108   };
109
110 extern int matherr __P ((struct exception *));
111
112 #define X_TLOSS         1.41484755040568800000e+16
113
114 /* Types of exceptions in the `type' field.  */
115 #define DOMAIN          1
116 #define SING            2
117 #define OVERFLOW        3
118 #define UNDERFLOW       4
119 #define TLOSS           5
120 #define PLOSS           6
121
122 /* SVID mode specifies returning this large value instead of infinity.  */
123 #define HUGE            FLT_MAX
124 #include <float.h>              /* Defines FLT_MAX.  */
125
126 #endif
127
128
129 #ifdef __USE_BSD
130
131 /* Some useful constants.  */
132 #define M_E             _Mldbl(2.7182818284590452354)   /* e */
133 #define M_LOG2E         _Mldbl(1.4426950408889634074)   /* log 2e */
134 #define M_LOG10E        _Mldbl(0.43429448190325182765)  /* log 10e */
135 #define M_LN2           _Mldbl(0.69314718055994530942)  /* log e2 */
136 #define M_LN10          _Mldbl(2.30258509299404568402)  /* log e10 */
137 #define M_PI            _Mldbl(3.14159265358979323846)  /* pi */
138 #define M_PI_2          _Mldbl(1.57079632679489661923)  /* pi/2 */
139 #define M_PI_4          _Mldbl(0.78539816339744830962)  /* pi/4 */
140 #define M_1_PI          _Mldbl(0.31830988618379067154)  /* 1/pi */
141 #define M_2_PI          _Mldbl(0.63661977236758134308)  /* 2/pi */
142 #define M_2_SQRTPI      _Mldbl(1.12837916709551257390)  /* 2/sqrt(pi) */
143 #define M_SQRT2         _Mldbl(1.41421356237309504880)  /* sqrt(2) */
144 #define M_SQRT1_2       _Mldbl(0.70710678118654752440)  /* 1/sqrt(2) */
145
146 /* Our constants might specify more precision than `double' can represent.
147    Use `long double' constants in standard and GNU C, where they are
148    supported and the cast to `double'.  */
149 #if __STDC__ - 0 || __GNUC__ - 0
150 #define _Mldbl(x) x##L
151 #else   /* Traditional C.  */
152 #define _Mldbl(x) x
153 #endif  /* Standard or GNU C.  */
154
155 #endif
156
157
158 /* Get machine-dependent inline versions (if there are any).  */
159 #if defined (__NO_MATH_INLINES) || defined (__OPTIMIZE__)
160 #include <__math.h>
161 #endif
162
163
164 __END_DECLS
165
166
167 #endif /* math.h  */