Correction.
[glibc.git] / math / math.h
blob4d08cd94b5ea1455c73eb4db4b82676353781fc5
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.
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.
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.
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. */
21 * ANSI Standard: 4.5 MATHEMATICS <math.h>
24 #ifndef _MATH_H
26 #define _MATH_H 1
27 #include <features.h>
29 __BEGIN_DECLS
31 #define __need_Emath
32 #include <errno.h>
34 /* Get machine-dependent HUGE_VAL value (returned on overflow).
35 On all IEEE754 machines, this is +Infinity. */
36 #include <huge_val.h>
38 /* Get machine-dependent NAN value (returned for some domain errors). */
39 #ifdef __USE_GNU
40 #include <nan.h>
41 #endif
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'. */
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
57 #define _Mdouble_ double
58 #define __MATH_PRECNAME(name,r) name##r
59 #include <mathcalls.h>
60 #undef _Mdouble_
61 #undef __MATH_PRECNAME
63 #ifdef __USE_MISC
66 /* Include the file of declarations again, this time using `float'
67 instead of `double' and appending f to each function name. */
69 #ifndef _Mfloat_
70 #define _Mfloat_ float
71 #endif
72 #define _Mdouble_ _Mfloat_
73 #define __MATH_PRECNAME(name,r) name##f##r
74 #include <mathcalls.h>
75 #undef _Mdouble_
76 #undef __MATH_PRECNAME
78 /* Include the file of declarations again, this time using `long double'
79 instead of `double' and appending l to each function name. */
81 #ifndef _Mlong_double_
82 #define _Mlong_double_ long double
83 #endif
84 #define _Mdouble_ _Mlong_double_
85 #define __MATH_PRECNAME(name,r) name##l##r
86 #include <mathcalls.h>
87 #undef _Mdouble_
88 #undef __MATH_PRECNAME
90 #endif /* Use misc. */
93 #ifdef __USE_MISC
94 /* Support for various different standard error handling behaviors. */
96 typedef enum { _IEEE_ = -1, _SVID_, _XOPEN_, _POSIX_ } _LIB_VERSION_TYPE;
98 /* This variable can be changed at run-time to any of the values above to
99 affect floating point error handling behavior (it may also be necessary
100 to change the hardware FPU exception settings). */
101 extern _LIB_VERSION_TYPE _LIB_VERSION;
102 #endif
105 #ifdef __USE_SVID
106 /* In SVID error handling, `matherr' is called with this description
107 of the exceptional condition. */
108 struct exception
110 int type;
111 char *name;
112 double arg1;
113 double arg2;
114 double retval;
117 extern int matherr __P ((struct exception *));
119 #define X_TLOSS 1.41484755040568800000e+16
121 /* Types of exceptions in the `type' field. */
122 #define DOMAIN 1
123 #define SING 2
124 #define OVERFLOW 3
125 #define UNDERFLOW 4
126 #define TLOSS 5
127 #define PLOSS 6
129 /* SVID mode specifies returning this large value instead of infinity. */
130 #define HUGE FLT_MAX
131 #include <float.h> /* Defines FLT_MAX. */
133 #endif
136 #ifdef __USE_BSD
138 /* Some useful constants. */
139 #define M_E _Mldbl(2.7182818284590452354) /* e */
140 #define M_LOG2E _Mldbl(1.4426950408889634074) /* log 2e */
141 #define M_LOG10E _Mldbl(0.43429448190325182765) /* log 10e */
142 #define M_LN2 _Mldbl(0.69314718055994530942) /* log e2 */
143 #define M_LN10 _Mldbl(2.30258509299404568402) /* log e10 */
144 #define M_PI _Mldbl(3.14159265358979323846) /* pi */
145 #define M_PI_2 _Mldbl(1.57079632679489661923) /* pi/2 */
146 #define M_PI_4 _Mldbl(0.78539816339744830962) /* pi/4 */
147 #define M_1_PI _Mldbl(0.31830988618379067154) /* 1/pi */
148 #define M_2_PI _Mldbl(0.63661977236758134308) /* 2/pi */
149 #define M_2_SQRTPI _Mldbl(1.12837916709551257390) /* 2/sqrt(pi) */
150 #define M_SQRT2 _Mldbl(1.41421356237309504880) /* sqrt(2) */
151 #define M_SQRT1_2 _Mldbl(0.70710678118654752440) /* 1/sqrt(2) */
153 /* Our constants might specify more precision than `double' can represent.
154 Use `long double' constants in standard and GNU C, where they are
155 supported and the cast to `double'. */
156 #if __STDC__ - 0 || __GNUC__ - 0
157 #define _Mldbl(x) x##L
158 #else /* Traditional C. */
159 #define _Mldbl(x) x
160 #endif /* Standard or GNU C. */
162 #endif
165 /* Get machine-dependent inline versions (if there are any). */
166 #if defined (__NO_MATH_INLINES) || defined (__OPTIMIZE__)
167 #include <__math.h>
168 #endif
171 __END_DECLS
174 #endif /* math.h */