Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1 | /* Math module -- standard C math library functions, pi and e */ |
| 2 | |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 3 | /* Here are some comments from Tim Peters, extracted from the |
| 4 | discussion attached to http://bugs.python.org/issue1640. They |
| 5 | describe the general aims of the math module with respect to |
| 6 | special values, IEEE-754 floating-point exceptions, and Python |
| 7 | exceptions. |
| 8 | |
| 9 | These are the "spirit of 754" rules: |
| 10 | |
| 11 | 1. If the mathematical result is a real number, but of magnitude too |
| 12 | large to approximate by a machine float, overflow is signaled and the |
| 13 | result is an infinity (with the appropriate sign). |
| 14 | |
| 15 | 2. If the mathematical result is a real number, but of magnitude too |
| 16 | small to approximate by a machine float, underflow is signaled and the |
| 17 | result is a zero (with the appropriate sign). |
| 18 | |
| 19 | 3. At a singularity (a value x such that the limit of f(y) as y |
| 20 | approaches x exists and is an infinity), "divide by zero" is signaled |
| 21 | and the result is an infinity (with the appropriate sign). This is |
| 22 | complicated a little by that the left-side and right-side limits may |
| 23 | not be the same; e.g., 1/x approaches +inf or -inf as x approaches 0 |
| 24 | from the positive or negative directions. In that specific case, the |
| 25 | sign of the zero determines the result of 1/0. |
| 26 | |
| 27 | 4. At a point where a function has no defined result in the extended |
| 28 | reals (i.e., the reals plus an infinity or two), invalid operation is |
| 29 | signaled and a NaN is returned. |
| 30 | |
| 31 | And these are what Python has historically /tried/ to do (but not |
| 32 | always successfully, as platform libm behavior varies a lot): |
| 33 | |
| 34 | For #1, raise OverflowError. |
| 35 | |
| 36 | For #2, return a zero (with the appropriate sign if that happens by |
| 37 | accident ;-)). |
| 38 | |
| 39 | For #3 and #4, raise ValueError. It may have made sense to raise |
| 40 | Python's ZeroDivisionError in #3, but historically that's only been |
| 41 | raised for division by zero and mod by zero. |
| 42 | |
| 43 | */ |
| 44 | |
| 45 | /* |
| 46 | In general, on an IEEE-754 platform the aim is to follow the C99 |
| 47 | standard, including Annex 'F', whenever possible. Where the |
| 48 | standard recommends raising the 'divide-by-zero' or 'invalid' |
| 49 | floating-point exceptions, Python should raise a ValueError. Where |
| 50 | the standard recommends raising 'overflow', Python should raise an |
| 51 | OverflowError. In all other circumstances a value should be |
| 52 | returned. |
| 53 | */ |
| 54 | |
Barry Warsaw | 8b43b19 | 1996-12-09 22:32:36 +0000 | [diff] [blame] | 55 | #include "Python.h" |
Michael W. Hudson | 9ef852c | 2005-04-06 13:05:18 +0000 | [diff] [blame] | 56 | #include "longintrepr.h" /* just for SHIFT */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 57 | |
Neal Norwitz | 5f95a79 | 2008-01-25 08:04:16 +0000 | [diff] [blame] | 58 | #ifdef _OSF_SOURCE |
| 59 | /* OSF1 5.1 doesn't make this available with XOPEN_SOURCE_EXTENDED defined */ |
| 60 | extern double copysign(double, double); |
| 61 | #endif |
| 62 | |
Tim Peters | 1d12061 | 2000-10-12 06:10:25 +0000 | [diff] [blame] | 63 | /* Call is_error when errno != 0, and where x is the result libm |
| 64 | * returned. is_error will usually set up an exception and return |
| 65 | * true (1), but may return false (0) without setting up an exception. |
| 66 | */ |
| 67 | static int |
| 68 | is_error(double x) |
Guido van Rossum | 8832b62 | 1991-12-16 15:44:24 +0000 | [diff] [blame] | 69 | { |
Tim Peters | 1d12061 | 2000-10-12 06:10:25 +0000 | [diff] [blame] | 70 | int result = 1; /* presumption of guilt */ |
Tim Peters | 2bf405a | 2000-10-12 19:42:00 +0000 | [diff] [blame] | 71 | assert(errno); /* non-zero errno is a precondition for calling */ |
Guido van Rossum | 8832b62 | 1991-12-16 15:44:24 +0000 | [diff] [blame] | 72 | if (errno == EDOM) |
Barry Warsaw | 8b43b19 | 1996-12-09 22:32:36 +0000 | [diff] [blame] | 73 | PyErr_SetString(PyExc_ValueError, "math domain error"); |
Tim Peters | a40c793 | 2001-09-05 22:36:56 +0000 | [diff] [blame] | 74 | |
Tim Peters | 1d12061 | 2000-10-12 06:10:25 +0000 | [diff] [blame] | 75 | else if (errno == ERANGE) { |
| 76 | /* ANSI C generally requires libm functions to set ERANGE |
| 77 | * on overflow, but also generally *allows* them to set |
| 78 | * ERANGE on underflow too. There's no consistency about |
Tim Peters | a40c793 | 2001-09-05 22:36:56 +0000 | [diff] [blame] | 79 | * the latter across platforms. |
| 80 | * Alas, C99 never requires that errno be set. |
| 81 | * Here we suppress the underflow errors (libm functions |
| 82 | * should return a zero on underflow, and +- HUGE_VAL on |
| 83 | * overflow, so testing the result for zero suffices to |
| 84 | * distinguish the cases). |
Tim Peters | 1d12061 | 2000-10-12 06:10:25 +0000 | [diff] [blame] | 85 | */ |
| 86 | if (x) |
Tim Peters | fe71f81 | 2001-08-07 22:10:00 +0000 | [diff] [blame] | 87 | PyErr_SetString(PyExc_OverflowError, |
Tim Peters | 1d12061 | 2000-10-12 06:10:25 +0000 | [diff] [blame] | 88 | "math range error"); |
| 89 | else |
| 90 | result = 0; |
| 91 | } |
Guido van Rossum | 8832b62 | 1991-12-16 15:44:24 +0000 | [diff] [blame] | 92 | else |
Barry Warsaw | 8b43b19 | 1996-12-09 22:32:36 +0000 | [diff] [blame] | 93 | /* Unexpected math error */ |
| 94 | PyErr_SetFromErrno(PyExc_ValueError); |
Tim Peters | 1d12061 | 2000-10-12 06:10:25 +0000 | [diff] [blame] | 95 | return result; |
Guido van Rossum | 8832b62 | 1991-12-16 15:44:24 +0000 | [diff] [blame] | 96 | } |
| 97 | |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 98 | /* |
Mark Dickinson | 92483cd | 2008-04-20 21:39:04 +0000 | [diff] [blame] | 99 | wrapper for atan2 that deals directly with special cases before |
| 100 | delegating to the platform libm for the remaining cases. This |
| 101 | is necessary to get consistent behaviour across platforms. |
| 102 | Windows, FreeBSD and alpha Tru64 are amongst platforms that don't |
| 103 | always follow C99. |
| 104 | */ |
| 105 | |
| 106 | static double |
| 107 | m_atan2(double y, double x) |
| 108 | { |
| 109 | if (Py_IS_NAN(x) || Py_IS_NAN(y)) |
| 110 | return Py_NAN; |
| 111 | if (Py_IS_INFINITY(y)) { |
| 112 | if (Py_IS_INFINITY(x)) { |
| 113 | if (copysign(1., x) == 1.) |
| 114 | /* atan2(+-inf, +inf) == +-pi/4 */ |
| 115 | return copysign(0.25*Py_MATH_PI, y); |
| 116 | else |
| 117 | /* atan2(+-inf, -inf) == +-pi*3/4 */ |
| 118 | return copysign(0.75*Py_MATH_PI, y); |
| 119 | } |
| 120 | /* atan2(+-inf, x) == +-pi/2 for finite x */ |
| 121 | return copysign(0.5*Py_MATH_PI, y); |
| 122 | } |
| 123 | if (Py_IS_INFINITY(x) || y == 0.) { |
| 124 | if (copysign(1., x) == 1.) |
| 125 | /* atan2(+-y, +inf) = atan2(+-0, +x) = +-0. */ |
| 126 | return copysign(0., y); |
| 127 | else |
| 128 | /* atan2(+-y, -inf) = atan2(+-0., -x) = +-pi. */ |
| 129 | return copysign(Py_MATH_PI, y); |
| 130 | } |
| 131 | return atan2(y, x); |
| 132 | } |
| 133 | |
| 134 | /* |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 135 | math_1 is used to wrap a libm function f that takes a double |
| 136 | arguments and returns a double. |
| 137 | |
| 138 | The error reporting follows these rules, which are designed to do |
| 139 | the right thing on C89/C99 platforms and IEEE 754/non IEEE 754 |
| 140 | platforms. |
| 141 | |
| 142 | - a NaN result from non-NaN inputs causes ValueError to be raised |
| 143 | - an infinite result from finite inputs causes OverflowError to be |
| 144 | raised if can_overflow is 1, or raises ValueError if can_overflow |
| 145 | is 0. |
| 146 | - if the result is finite and errno == EDOM then ValueError is |
| 147 | raised |
| 148 | - if the result is finite and nonzero and errno == ERANGE then |
| 149 | OverflowError is raised |
| 150 | |
| 151 | The last rule is used to catch overflow on platforms which follow |
| 152 | C89 but for which HUGE_VAL is not an infinity. |
| 153 | |
| 154 | For the majority of one-argument functions these rules are enough |
| 155 | to ensure that Python's functions behave as specified in 'Annex F' |
| 156 | of the C99 standard, with the 'invalid' and 'divide-by-zero' |
| 157 | floating-point exceptions mapping to Python's ValueError and the |
| 158 | 'overflow' floating-point exception mapping to OverflowError. |
| 159 | math_1 only works for functions that don't have singularities *and* |
| 160 | the possibility of overflow; fortunately, that covers everything we |
| 161 | care about right now. |
| 162 | */ |
| 163 | |
Barry Warsaw | 8b43b19 | 1996-12-09 22:32:36 +0000 | [diff] [blame] | 164 | static PyObject * |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 165 | math_1(PyObject *arg, double (*func) (double), int can_overflow) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 166 | { |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 167 | double x, r; |
| 168 | x = PyFloat_AsDouble(arg); |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 169 | if (x == -1.0 && PyErr_Occurred()) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 170 | return NULL; |
| 171 | errno = 0; |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 172 | PyFPE_START_PROTECT("in math_1", return 0); |
| 173 | r = (*func)(x); |
| 174 | PyFPE_END_PROTECT(r); |
| 175 | if (Py_IS_NAN(r)) { |
| 176 | if (!Py_IS_NAN(x)) |
| 177 | errno = EDOM; |
| 178 | else |
| 179 | errno = 0; |
| 180 | } |
| 181 | else if (Py_IS_INFINITY(r)) { |
| 182 | if (Py_IS_FINITE(x)) |
| 183 | errno = can_overflow ? ERANGE : EDOM; |
| 184 | else |
| 185 | errno = 0; |
| 186 | } |
| 187 | if (errno && is_error(r)) |
Tim Peters | 1d12061 | 2000-10-12 06:10:25 +0000 | [diff] [blame] | 188 | return NULL; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 189 | else |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 190 | return PyFloat_FromDouble(r); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 191 | } |
| 192 | |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 193 | /* |
| 194 | math_2 is used to wrap a libm function f that takes two double |
| 195 | arguments and returns a double. |
| 196 | |
| 197 | The error reporting follows these rules, which are designed to do |
| 198 | the right thing on C89/C99 platforms and IEEE 754/non IEEE 754 |
| 199 | platforms. |
| 200 | |
| 201 | - a NaN result from non-NaN inputs causes ValueError to be raised |
| 202 | - an infinite result from finite inputs causes OverflowError to be |
| 203 | raised. |
| 204 | - if the result is finite and errno == EDOM then ValueError is |
| 205 | raised |
| 206 | - if the result is finite and nonzero and errno == ERANGE then |
| 207 | OverflowError is raised |
| 208 | |
| 209 | The last rule is used to catch overflow on platforms which follow |
| 210 | C89 but for which HUGE_VAL is not an infinity. |
| 211 | |
| 212 | For most two-argument functions (copysign, fmod, hypot, atan2) |
| 213 | these rules are enough to ensure that Python's functions behave as |
| 214 | specified in 'Annex F' of the C99 standard, with the 'invalid' and |
| 215 | 'divide-by-zero' floating-point exceptions mapping to Python's |
| 216 | ValueError and the 'overflow' floating-point exception mapping to |
| 217 | OverflowError. |
| 218 | */ |
| 219 | |
Barry Warsaw | 8b43b19 | 1996-12-09 22:32:36 +0000 | [diff] [blame] | 220 | static PyObject * |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 221 | math_2(PyObject *args, double (*func) (double, double), char *funcname) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 222 | { |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 223 | PyObject *ox, *oy; |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 224 | double x, y, r; |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 225 | if (! PyArg_UnpackTuple(args, funcname, 2, 2, &ox, &oy)) |
| 226 | return NULL; |
| 227 | x = PyFloat_AsDouble(ox); |
| 228 | y = PyFloat_AsDouble(oy); |
| 229 | if ((x == -1.0 || y == -1.0) && PyErr_Occurred()) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 230 | return NULL; |
| 231 | errno = 0; |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 232 | PyFPE_START_PROTECT("in math_2", return 0); |
| 233 | r = (*func)(x, y); |
| 234 | PyFPE_END_PROTECT(r); |
| 235 | if (Py_IS_NAN(r)) { |
| 236 | if (!Py_IS_NAN(x) && !Py_IS_NAN(y)) |
| 237 | errno = EDOM; |
| 238 | else |
| 239 | errno = 0; |
| 240 | } |
| 241 | else if (Py_IS_INFINITY(r)) { |
| 242 | if (Py_IS_FINITE(x) && Py_IS_FINITE(y)) |
| 243 | errno = ERANGE; |
| 244 | else |
| 245 | errno = 0; |
| 246 | } |
| 247 | if (errno && is_error(r)) |
Tim Peters | 1d12061 | 2000-10-12 06:10:25 +0000 | [diff] [blame] | 248 | return NULL; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 249 | else |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 250 | return PyFloat_FromDouble(r); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 251 | } |
| 252 | |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 253 | #define FUNC1(funcname, func, can_overflow, docstring) \ |
Fred Drake | 40c4868 | 2000-07-03 18:11:56 +0000 | [diff] [blame] | 254 | static PyObject * math_##funcname(PyObject *self, PyObject *args) { \ |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 255 | return math_1(args, func, can_overflow); \ |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 256 | }\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 257 | PyDoc_STRVAR(math_##funcname##_doc, docstring); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 258 | |
Fred Drake | 40c4868 | 2000-07-03 18:11:56 +0000 | [diff] [blame] | 259 | #define FUNC2(funcname, func, docstring) \ |
| 260 | static PyObject * math_##funcname(PyObject *self, PyObject *args) { \ |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 261 | return math_2(args, func, #funcname); \ |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 262 | }\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 263 | PyDoc_STRVAR(math_##funcname##_doc, docstring); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 264 | |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 265 | FUNC1(acos, acos, 0, |
Tim Peters | fe71f81 | 2001-08-07 22:10:00 +0000 | [diff] [blame] | 266 | "acos(x)\n\nReturn the arc cosine (measured in radians) of x.") |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 267 | FUNC1(acosh, acosh, 0, |
| 268 | "acosh(x)\n\nReturn the hyperbolic arc cosine (measured in radians) of x.") |
| 269 | FUNC1(asin, asin, 0, |
Tim Peters | fe71f81 | 2001-08-07 22:10:00 +0000 | [diff] [blame] | 270 | "asin(x)\n\nReturn the arc sine (measured in radians) of x.") |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 271 | FUNC1(asinh, asinh, 0, |
| 272 | "asinh(x)\n\nReturn the hyperbolic arc sine (measured in radians) of x.") |
| 273 | FUNC1(atan, atan, 0, |
Tim Peters | fe71f81 | 2001-08-07 22:10:00 +0000 | [diff] [blame] | 274 | "atan(x)\n\nReturn the arc tangent (measured in radians) of x.") |
Mark Dickinson | 92483cd | 2008-04-20 21:39:04 +0000 | [diff] [blame] | 275 | FUNC2(atan2, m_atan2, |
Tim Peters | fe71f81 | 2001-08-07 22:10:00 +0000 | [diff] [blame] | 276 | "atan2(y, x)\n\nReturn the arc tangent (measured in radians) of y/x.\n" |
| 277 | "Unlike atan(y/x), the signs of both x and y are considered.") |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 278 | FUNC1(atanh, atanh, 0, |
| 279 | "atanh(x)\n\nReturn the hyperbolic arc tangent (measured in radians) of x.") |
| 280 | FUNC1(ceil, ceil, 0, |
Jeffrey Yasskin | 9871d8f | 2008-01-05 08:47:13 +0000 | [diff] [blame] | 281 | "ceil(x)\n\nReturn the ceiling of x as a float.\n" |
| 282 | "This is the smallest integral value >= x.") |
Christian Heimes | eebb79c | 2008-01-03 22:32:26 +0000 | [diff] [blame] | 283 | FUNC2(copysign, copysign, |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 284 | "copysign(x,y)\n\nReturn x with the sign of y.") |
| 285 | FUNC1(cos, cos, 0, |
| 286 | "cos(x)\n\nReturn the cosine of x (measured in radians).") |
| 287 | FUNC1(cosh, cosh, 1, |
| 288 | "cosh(x)\n\nReturn the hyperbolic cosine of x.") |
| 289 | FUNC1(exp, exp, 1, |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 290 | "exp(x)\n\nReturn e raised to the power of x.") |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 291 | FUNC1(fabs, fabs, 0, |
Tim Peters | fe71f81 | 2001-08-07 22:10:00 +0000 | [diff] [blame] | 292 | "fabs(x)\n\nReturn the absolute value of the float x.") |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 293 | FUNC1(floor, floor, 0, |
Jeffrey Yasskin | 9871d8f | 2008-01-05 08:47:13 +0000 | [diff] [blame] | 294 | "floor(x)\n\nReturn the floor of x as a float.\n" |
| 295 | "This is the largest integral value <= x.") |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 296 | FUNC1(log1p, log1p, 1, |
| 297 | "log1p(x)\n\nReturn the natural logarithm of 1+x (base e).\n\ |
| 298 | The result is computed in a way which is accurate for x near zero.") |
| 299 | FUNC1(sin, sin, 0, |
Tim Peters | fe71f81 | 2001-08-07 22:10:00 +0000 | [diff] [blame] | 300 | "sin(x)\n\nReturn the sine of x (measured in radians).") |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 301 | FUNC1(sinh, sinh, 1, |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 302 | "sinh(x)\n\nReturn the hyperbolic sine of x.") |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 303 | FUNC1(sqrt, sqrt, 0, |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 304 | "sqrt(x)\n\nReturn the square root of x.") |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 305 | FUNC1(tan, tan, 0, |
Tim Peters | fe71f81 | 2001-08-07 22:10:00 +0000 | [diff] [blame] | 306 | "tan(x)\n\nReturn the tangent of x (measured in radians).") |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 307 | FUNC1(tanh, tanh, 0, |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 308 | "tanh(x)\n\nReturn the hyperbolic tangent of x.") |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 309 | |
Barry Warsaw | 8b43b19 | 1996-12-09 22:32:36 +0000 | [diff] [blame] | 310 | static PyObject * |
Jeffrey Yasskin | ca2b69f | 2008-02-01 06:22:46 +0000 | [diff] [blame] | 311 | math_trunc(PyObject *self, PyObject *number) |
| 312 | { |
Jeffrey Yasskin | ca2b69f | 2008-02-01 06:22:46 +0000 | [diff] [blame] | 313 | return PyObject_CallMethod(number, "__trunc__", NULL); |
| 314 | } |
| 315 | |
| 316 | PyDoc_STRVAR(math_trunc_doc, |
| 317 | "trunc(x:Real) -> Integral\n" |
| 318 | "\n" |
Raymond Hettinger | fe424f7 | 2008-02-02 05:24:44 +0000 | [diff] [blame] | 319 | "Truncates x to the nearest Integral toward 0. Uses the __trunc__ magic method."); |
Jeffrey Yasskin | ca2b69f | 2008-02-01 06:22:46 +0000 | [diff] [blame] | 320 | |
| 321 | static PyObject * |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 322 | math_frexp(PyObject *self, PyObject *arg) |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 323 | { |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 324 | int i; |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 325 | double x = PyFloat_AsDouble(arg); |
| 326 | if (x == -1.0 && PyErr_Occurred()) |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 327 | return NULL; |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 328 | /* deal with special cases directly, to sidestep platform |
| 329 | differences */ |
| 330 | if (Py_IS_NAN(x) || Py_IS_INFINITY(x) || !x) { |
| 331 | i = 0; |
| 332 | } |
| 333 | else { |
| 334 | PyFPE_START_PROTECT("in math_frexp", return 0); |
| 335 | x = frexp(x, &i); |
| 336 | PyFPE_END_PROTECT(x); |
| 337 | } |
| 338 | return Py_BuildValue("(di)", x, i); |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 339 | } |
| 340 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 341 | PyDoc_STRVAR(math_frexp_doc, |
Tim Peters | 63c9453 | 2001-09-04 23:17:42 +0000 | [diff] [blame] | 342 | "frexp(x)\n" |
| 343 | "\n" |
| 344 | "Return the mantissa and exponent of x, as pair (m, e).\n" |
| 345 | "m is a float and e is an int, such that x = m * 2.**e.\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 346 | "If x is 0, m and e are both 0. Else 0.5 <= abs(m) < 1.0."); |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 347 | |
Barry Warsaw | 8b43b19 | 1996-12-09 22:32:36 +0000 | [diff] [blame] | 348 | static PyObject * |
Fred Drake | 40c4868 | 2000-07-03 18:11:56 +0000 | [diff] [blame] | 349 | math_ldexp(PyObject *self, PyObject *args) |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 350 | { |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 351 | double x, r; |
Guido van Rossum | c554505 | 2000-05-08 14:29:38 +0000 | [diff] [blame] | 352 | int exp; |
Fred Drake | 40c4868 | 2000-07-03 18:11:56 +0000 | [diff] [blame] | 353 | if (! PyArg_ParseTuple(args, "di:ldexp", &x, &exp)) |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 354 | return NULL; |
| 355 | errno = 0; |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 356 | PyFPE_START_PROTECT("in math_ldexp", return 0) |
| 357 | r = ldexp(x, exp); |
| 358 | PyFPE_END_PROTECT(r) |
| 359 | if (Py_IS_FINITE(x) && Py_IS_INFINITY(r)) |
| 360 | errno = ERANGE; |
| 361 | /* Windows MSVC8 sets errno = EDOM on ldexp(NaN, i); |
| 362 | we unset it to avoid raising a ValueError here. */ |
| 363 | if (errno == EDOM) |
| 364 | errno = 0; |
| 365 | if (errno && is_error(r)) |
Tim Peters | 1d12061 | 2000-10-12 06:10:25 +0000 | [diff] [blame] | 366 | return NULL; |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 367 | else |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 368 | return PyFloat_FromDouble(r); |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 369 | } |
| 370 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 371 | PyDoc_STRVAR(math_ldexp_doc, |
| 372 | "ldexp(x, i) -> x * (2**i)"); |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 373 | |
Barry Warsaw | 8b43b19 | 1996-12-09 22:32:36 +0000 | [diff] [blame] | 374 | static PyObject * |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 375 | math_modf(PyObject *self, PyObject *arg) |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 376 | { |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 377 | double y, x = PyFloat_AsDouble(arg); |
| 378 | if (x == -1.0 && PyErr_Occurred()) |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 379 | return NULL; |
Mark Dickinson | b2f7090 | 2008-04-20 01:39:24 +0000 | [diff] [blame] | 380 | /* some platforms don't do the right thing for NaNs and |
| 381 | infinities, so we take care of special cases directly. */ |
| 382 | if (!Py_IS_FINITE(x)) { |
| 383 | if (Py_IS_INFINITY(x)) |
| 384 | return Py_BuildValue("(dd)", copysign(0., x), x); |
| 385 | else if (Py_IS_NAN(x)) |
| 386 | return Py_BuildValue("(dd)", x, x); |
| 387 | } |
| 388 | |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 389 | errno = 0; |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 390 | PyFPE_START_PROTECT("in math_modf", return 0); |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 391 | x = modf(x, &y); |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 392 | PyFPE_END_PROTECT(x); |
| 393 | return Py_BuildValue("(dd)", x, y); |
Guido van Rossum | d18ad58 | 1991-10-24 14:57:21 +0000 | [diff] [blame] | 394 | } |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 395 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 396 | PyDoc_STRVAR(math_modf_doc, |
Tim Peters | 63c9453 | 2001-09-04 23:17:42 +0000 | [diff] [blame] | 397 | "modf(x)\n" |
| 398 | "\n" |
| 399 | "Return the fractional and integer parts of x. Both results carry the sign\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 400 | "of x. The integer part is returned as a real."); |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 401 | |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 402 | /* A decent logarithm is easy to compute even for huge longs, but libm can't |
| 403 | do that by itself -- loghelper can. func is log or log10, and name is |
| 404 | "log" or "log10". Note that overflow isn't possible: a long can contain |
| 405 | no more than INT_MAX * SHIFT bits, so has value certainly less than |
| 406 | 2**(2**64 * 2**16) == 2**2**80, and log2 of that is 2**80, which is |
| 407 | small enough to fit in an IEEE single. log and log10 are even smaller. |
| 408 | */ |
| 409 | |
| 410 | static PyObject* |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 411 | loghelper(PyObject* arg, double (*func)(double), char *funcname) |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 412 | { |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 413 | /* If it is long, do it ourselves. */ |
| 414 | if (PyLong_Check(arg)) { |
| 415 | double x; |
| 416 | int e; |
| 417 | x = _PyLong_AsScaledDouble(arg, &e); |
| 418 | if (x <= 0.0) { |
| 419 | PyErr_SetString(PyExc_ValueError, |
| 420 | "math domain error"); |
| 421 | return NULL; |
| 422 | } |
Christian Heimes | 543cabc | 2008-01-25 14:54:23 +0000 | [diff] [blame] | 423 | /* Value is ~= x * 2**(e*PyLong_SHIFT), so the log ~= |
| 424 | log(x) + log(2) * e * PyLong_SHIFT. |
| 425 | CAUTION: e*PyLong_SHIFT may overflow using int arithmetic, |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 426 | so force use of double. */ |
Christian Heimes | 543cabc | 2008-01-25 14:54:23 +0000 | [diff] [blame] | 427 | x = func(x) + (e * (double)PyLong_SHIFT) * func(2.0); |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 428 | return PyFloat_FromDouble(x); |
| 429 | } |
| 430 | |
| 431 | /* Else let libm handle it by itself. */ |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 432 | return math_1(arg, func, 0); |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 433 | } |
| 434 | |
| 435 | static PyObject * |
| 436 | math_log(PyObject *self, PyObject *args) |
| 437 | { |
Raymond Hettinger | 866964c | 2002-12-14 19:51:34 +0000 | [diff] [blame] | 438 | PyObject *arg; |
| 439 | PyObject *base = NULL; |
| 440 | PyObject *num, *den; |
| 441 | PyObject *ans; |
Raymond Hettinger | 866964c | 2002-12-14 19:51:34 +0000 | [diff] [blame] | 442 | |
Raymond Hettinger | ea3fdf4 | 2002-12-29 16:33:45 +0000 | [diff] [blame] | 443 | if (!PyArg_UnpackTuple(args, "log", 1, 2, &arg, &base)) |
Raymond Hettinger | 866964c | 2002-12-14 19:51:34 +0000 | [diff] [blame] | 444 | return NULL; |
Raymond Hettinger | 866964c | 2002-12-14 19:51:34 +0000 | [diff] [blame] | 445 | |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 446 | num = loghelper(arg, log, "log"); |
| 447 | if (num == NULL || base == NULL) |
| 448 | return num; |
Raymond Hettinger | 866964c | 2002-12-14 19:51:34 +0000 | [diff] [blame] | 449 | |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 450 | den = loghelper(base, log, "log"); |
Raymond Hettinger | 866964c | 2002-12-14 19:51:34 +0000 | [diff] [blame] | 451 | if (den == NULL) { |
| 452 | Py_DECREF(num); |
| 453 | return NULL; |
| 454 | } |
| 455 | |
| 456 | ans = PyNumber_Divide(num, den); |
| 457 | Py_DECREF(num); |
| 458 | Py_DECREF(den); |
| 459 | return ans; |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 460 | } |
| 461 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 462 | PyDoc_STRVAR(math_log_doc, |
Raymond Hettinger | 866964c | 2002-12-14 19:51:34 +0000 | [diff] [blame] | 463 | "log(x[, base]) -> the logarithm of x to the given base.\n\ |
| 464 | If the base not specified, returns the natural logarithm (base e) of x."); |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 465 | |
| 466 | static PyObject * |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 467 | math_log10(PyObject *self, PyObject *arg) |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 468 | { |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 469 | return loghelper(arg, log10, "log10"); |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 470 | } |
| 471 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 472 | PyDoc_STRVAR(math_log10_doc, |
| 473 | "log10(x) -> the base 10 logarithm of x."); |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 474 | |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 475 | static PyObject * |
| 476 | math_fmod(PyObject *self, PyObject *args) |
| 477 | { |
| 478 | PyObject *ox, *oy; |
| 479 | double r, x, y; |
| 480 | if (! PyArg_UnpackTuple(args, "fmod", 2, 2, &ox, &oy)) |
| 481 | return NULL; |
| 482 | x = PyFloat_AsDouble(ox); |
| 483 | y = PyFloat_AsDouble(oy); |
| 484 | if ((x == -1.0 || y == -1.0) && PyErr_Occurred()) |
| 485 | return NULL; |
| 486 | /* fmod(x, +/-Inf) returns x for finite x. */ |
| 487 | if (Py_IS_INFINITY(y) && Py_IS_FINITE(x)) |
| 488 | return PyFloat_FromDouble(x); |
| 489 | errno = 0; |
| 490 | PyFPE_START_PROTECT("in math_fmod", return 0); |
| 491 | r = fmod(x, y); |
| 492 | PyFPE_END_PROTECT(r); |
| 493 | if (Py_IS_NAN(r)) { |
| 494 | if (!Py_IS_NAN(x) && !Py_IS_NAN(y)) |
| 495 | errno = EDOM; |
| 496 | else |
| 497 | errno = 0; |
| 498 | } |
| 499 | if (errno && is_error(r)) |
| 500 | return NULL; |
| 501 | else |
| 502 | return PyFloat_FromDouble(r); |
| 503 | } |
| 504 | |
| 505 | PyDoc_STRVAR(math_fmod_doc, |
| 506 | "fmod(x,y)\n\nReturn fmod(x, y), according to platform C." |
| 507 | " x % y may differ."); |
| 508 | |
| 509 | static PyObject * |
| 510 | math_hypot(PyObject *self, PyObject *args) |
| 511 | { |
| 512 | PyObject *ox, *oy; |
| 513 | double r, x, y; |
| 514 | if (! PyArg_UnpackTuple(args, "hypot", 2, 2, &ox, &oy)) |
| 515 | return NULL; |
| 516 | x = PyFloat_AsDouble(ox); |
| 517 | y = PyFloat_AsDouble(oy); |
| 518 | if ((x == -1.0 || y == -1.0) && PyErr_Occurred()) |
| 519 | return NULL; |
| 520 | /* hypot(x, +/-Inf) returns Inf, even if x is a NaN. */ |
| 521 | if (Py_IS_INFINITY(x)) |
| 522 | return PyFloat_FromDouble(fabs(x)); |
| 523 | if (Py_IS_INFINITY(y)) |
| 524 | return PyFloat_FromDouble(fabs(y)); |
| 525 | errno = 0; |
| 526 | PyFPE_START_PROTECT("in math_hypot", return 0); |
| 527 | r = hypot(x, y); |
| 528 | PyFPE_END_PROTECT(r); |
| 529 | if (Py_IS_NAN(r)) { |
| 530 | if (!Py_IS_NAN(x) && !Py_IS_NAN(y)) |
| 531 | errno = EDOM; |
| 532 | else |
| 533 | errno = 0; |
| 534 | } |
| 535 | else if (Py_IS_INFINITY(r)) { |
| 536 | if (Py_IS_FINITE(x) && Py_IS_FINITE(y)) |
| 537 | errno = ERANGE; |
| 538 | else |
| 539 | errno = 0; |
| 540 | } |
| 541 | if (errno && is_error(r)) |
| 542 | return NULL; |
| 543 | else |
| 544 | return PyFloat_FromDouble(r); |
| 545 | } |
| 546 | |
| 547 | PyDoc_STRVAR(math_hypot_doc, |
| 548 | "hypot(x,y)\n\nReturn the Euclidean distance, sqrt(x*x + y*y)."); |
| 549 | |
| 550 | /* pow can't use math_2, but needs its own wrapper: the problem is |
| 551 | that an infinite result can arise either as a result of overflow |
| 552 | (in which case OverflowError should be raised) or as a result of |
| 553 | e.g. 0.**-5. (for which ValueError needs to be raised.) |
| 554 | */ |
| 555 | |
| 556 | static PyObject * |
| 557 | math_pow(PyObject *self, PyObject *args) |
| 558 | { |
| 559 | PyObject *ox, *oy; |
| 560 | double r, x, y; |
Mark Dickinson | cec3f13 | 2008-04-20 04:13:13 +0000 | [diff] [blame] | 561 | int odd_y; |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 562 | |
| 563 | if (! PyArg_UnpackTuple(args, "pow", 2, 2, &ox, &oy)) |
| 564 | return NULL; |
| 565 | x = PyFloat_AsDouble(ox); |
| 566 | y = PyFloat_AsDouble(oy); |
| 567 | if ((x == -1.0 || y == -1.0) && PyErr_Occurred()) |
| 568 | return NULL; |
Mark Dickinson | a1293eb | 2008-04-19 19:41:52 +0000 | [diff] [blame] | 569 | |
Mark Dickinson | cec3f13 | 2008-04-20 04:13:13 +0000 | [diff] [blame] | 570 | /* deal directly with IEEE specials, to cope with problems on various |
| 571 | platforms whose semantics don't exactly match C99 */ |
Mark Dickinson | 0da94c8 | 2008-04-21 01:55:50 +0000 | [diff] [blame] | 572 | r = 0.; /* silence compiler warning */ |
Mark Dickinson | cec3f13 | 2008-04-20 04:13:13 +0000 | [diff] [blame] | 573 | if (!Py_IS_FINITE(x) || !Py_IS_FINITE(y)) { |
| 574 | errno = 0; |
| 575 | if (Py_IS_NAN(x)) |
| 576 | r = y == 0. ? 1. : x; /* NaN**0 = 1 */ |
| 577 | else if (Py_IS_NAN(y)) |
| 578 | r = x == 1. ? 1. : y; /* 1**NaN = 1 */ |
| 579 | else if (Py_IS_INFINITY(x)) { |
| 580 | odd_y = Py_IS_FINITE(y) && fmod(fabs(y), 2.0) == 1.0; |
| 581 | if (y > 0.) |
| 582 | r = odd_y ? x : fabs(x); |
| 583 | else if (y == 0.) |
| 584 | r = 1.; |
| 585 | else /* y < 0. */ |
| 586 | r = odd_y ? copysign(0., x) : 0.; |
| 587 | } |
| 588 | else if (Py_IS_INFINITY(y)) { |
| 589 | if (fabs(x) == 1.0) |
| 590 | r = 1.; |
| 591 | else if (y > 0. && fabs(x) > 1.0) |
| 592 | r = y; |
| 593 | else if (y < 0. && fabs(x) < 1.0) { |
| 594 | r = -y; /* result is +inf */ |
| 595 | if (x == 0.) /* 0**-inf: divide-by-zero */ |
| 596 | errno = EDOM; |
| 597 | } |
| 598 | else |
| 599 | r = 0.; |
| 600 | } |
Mark Dickinson | e941d97 | 2008-04-19 18:51:48 +0000 | [diff] [blame] | 601 | } |
Mark Dickinson | cec3f13 | 2008-04-20 04:13:13 +0000 | [diff] [blame] | 602 | else { |
| 603 | /* let libm handle finite**finite */ |
| 604 | errno = 0; |
| 605 | PyFPE_START_PROTECT("in math_pow", return 0); |
| 606 | r = pow(x, y); |
| 607 | PyFPE_END_PROTECT(r); |
| 608 | /* a NaN result should arise only from (-ve)**(finite |
| 609 | non-integer); in this case we want to raise ValueError. */ |
| 610 | if (!Py_IS_FINITE(r)) { |
| 611 | if (Py_IS_NAN(r)) { |
| 612 | errno = EDOM; |
| 613 | } |
| 614 | /* |
| 615 | an infinite result here arises either from: |
| 616 | (A) (+/-0.)**negative (-> divide-by-zero) |
| 617 | (B) overflow of x**y with x and y finite |
| 618 | */ |
| 619 | else if (Py_IS_INFINITY(r)) { |
| 620 | if (x == 0.) |
| 621 | errno = EDOM; |
| 622 | else |
| 623 | errno = ERANGE; |
| 624 | } |
| 625 | } |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 626 | } |
| 627 | |
| 628 | if (errno && is_error(r)) |
| 629 | return NULL; |
| 630 | else |
| 631 | return PyFloat_FromDouble(r); |
| 632 | } |
| 633 | |
| 634 | PyDoc_STRVAR(math_pow_doc, |
| 635 | "pow(x,y)\n\nReturn x**y (x to the power of y)."); |
| 636 | |
Christian Heimes | e2ca424 | 2008-01-03 20:23:15 +0000 | [diff] [blame] | 637 | static const double degToRad = Py_MATH_PI / 180.0; |
| 638 | static const double radToDeg = 180.0 / Py_MATH_PI; |
Raymond Hettinger | d6f2267 | 2002-05-13 03:56:10 +0000 | [diff] [blame] | 639 | |
| 640 | static PyObject * |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 641 | math_degrees(PyObject *self, PyObject *arg) |
Raymond Hettinger | d6f2267 | 2002-05-13 03:56:10 +0000 | [diff] [blame] | 642 | { |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 643 | double x = PyFloat_AsDouble(arg); |
| 644 | if (x == -1.0 && PyErr_Occurred()) |
Raymond Hettinger | d6f2267 | 2002-05-13 03:56:10 +0000 | [diff] [blame] | 645 | return NULL; |
Christian Heimes | e2ca424 | 2008-01-03 20:23:15 +0000 | [diff] [blame] | 646 | return PyFloat_FromDouble(x * radToDeg); |
Raymond Hettinger | d6f2267 | 2002-05-13 03:56:10 +0000 | [diff] [blame] | 647 | } |
| 648 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 649 | PyDoc_STRVAR(math_degrees_doc, |
| 650 | "degrees(x) -> converts angle x from radians to degrees"); |
Raymond Hettinger | d6f2267 | 2002-05-13 03:56:10 +0000 | [diff] [blame] | 651 | |
| 652 | static PyObject * |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 653 | math_radians(PyObject *self, PyObject *arg) |
Raymond Hettinger | d6f2267 | 2002-05-13 03:56:10 +0000 | [diff] [blame] | 654 | { |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 655 | double x = PyFloat_AsDouble(arg); |
| 656 | if (x == -1.0 && PyErr_Occurred()) |
Raymond Hettinger | d6f2267 | 2002-05-13 03:56:10 +0000 | [diff] [blame] | 657 | return NULL; |
| 658 | return PyFloat_FromDouble(x * degToRad); |
| 659 | } |
| 660 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 661 | PyDoc_STRVAR(math_radians_doc, |
| 662 | "radians(x) -> converts angle x from degrees to radians"); |
Tim Peters | 7852616 | 2001-09-05 00:53:45 +0000 | [diff] [blame] | 663 | |
Christian Heimes | e2ca424 | 2008-01-03 20:23:15 +0000 | [diff] [blame] | 664 | static PyObject * |
| 665 | math_isnan(PyObject *self, PyObject *arg) |
| 666 | { |
| 667 | double x = PyFloat_AsDouble(arg); |
| 668 | if (x == -1.0 && PyErr_Occurred()) |
| 669 | return NULL; |
| 670 | return PyBool_FromLong((long)Py_IS_NAN(x)); |
| 671 | } |
| 672 | |
| 673 | PyDoc_STRVAR(math_isnan_doc, |
| 674 | "isnan(x) -> bool\n\ |
| 675 | Checks if float x is not a number (NaN)"); |
| 676 | |
| 677 | static PyObject * |
| 678 | math_isinf(PyObject *self, PyObject *arg) |
| 679 | { |
| 680 | double x = PyFloat_AsDouble(arg); |
| 681 | if (x == -1.0 && PyErr_Occurred()) |
| 682 | return NULL; |
| 683 | return PyBool_FromLong((long)Py_IS_INFINITY(x)); |
| 684 | } |
| 685 | |
| 686 | PyDoc_STRVAR(math_isinf_doc, |
| 687 | "isinf(x) -> bool\n\ |
| 688 | Checks if float x is infinite (positive or negative)"); |
| 689 | |
Barry Warsaw | 8b43b19 | 1996-12-09 22:32:36 +0000 | [diff] [blame] | 690 | static PyMethodDef math_methods[] = { |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 691 | {"acos", math_acos, METH_O, math_acos_doc}, |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 692 | {"acosh", math_acosh, METH_O, math_acosh_doc}, |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 693 | {"asin", math_asin, METH_O, math_asin_doc}, |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 694 | {"asinh", math_asinh, METH_O, math_asinh_doc}, |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 695 | {"atan", math_atan, METH_O, math_atan_doc}, |
Fred Drake | 40c4868 | 2000-07-03 18:11:56 +0000 | [diff] [blame] | 696 | {"atan2", math_atan2, METH_VARARGS, math_atan2_doc}, |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 697 | {"atanh", math_atanh, METH_O, math_atanh_doc}, |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 698 | {"ceil", math_ceil, METH_O, math_ceil_doc}, |
Christian Heimes | eebb79c | 2008-01-03 22:32:26 +0000 | [diff] [blame] | 699 | {"copysign", math_copysign, METH_VARARGS, math_copysign_doc}, |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 700 | {"cos", math_cos, METH_O, math_cos_doc}, |
| 701 | {"cosh", math_cosh, METH_O, math_cosh_doc}, |
| 702 | {"degrees", math_degrees, METH_O, math_degrees_doc}, |
| 703 | {"exp", math_exp, METH_O, math_exp_doc}, |
| 704 | {"fabs", math_fabs, METH_O, math_fabs_doc}, |
| 705 | {"floor", math_floor, METH_O, math_floor_doc}, |
Fred Drake | 40c4868 | 2000-07-03 18:11:56 +0000 | [diff] [blame] | 706 | {"fmod", math_fmod, METH_VARARGS, math_fmod_doc}, |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 707 | {"frexp", math_frexp, METH_O, math_frexp_doc}, |
Fred Drake | 40c4868 | 2000-07-03 18:11:56 +0000 | [diff] [blame] | 708 | {"hypot", math_hypot, METH_VARARGS, math_hypot_doc}, |
Christian Heimes | e2ca424 | 2008-01-03 20:23:15 +0000 | [diff] [blame] | 709 | {"isinf", math_isinf, METH_O, math_isinf_doc}, |
| 710 | {"isnan", math_isnan, METH_O, math_isnan_doc}, |
Fred Drake | 40c4868 | 2000-07-03 18:11:56 +0000 | [diff] [blame] | 711 | {"ldexp", math_ldexp, METH_VARARGS, math_ldexp_doc}, |
| 712 | {"log", math_log, METH_VARARGS, math_log_doc}, |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 713 | {"log1p", math_log1p, METH_O, math_log1p_doc}, |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 714 | {"log10", math_log10, METH_O, math_log10_doc}, |
| 715 | {"modf", math_modf, METH_O, math_modf_doc}, |
Fred Drake | 40c4868 | 2000-07-03 18:11:56 +0000 | [diff] [blame] | 716 | {"pow", math_pow, METH_VARARGS, math_pow_doc}, |
Neal Norwitz | 45e230a | 2006-11-19 21:26:53 +0000 | [diff] [blame] | 717 | {"radians", math_radians, METH_O, math_radians_doc}, |
| 718 | {"sin", math_sin, METH_O, math_sin_doc}, |
| 719 | {"sinh", math_sinh, METH_O, math_sinh_doc}, |
| 720 | {"sqrt", math_sqrt, METH_O, math_sqrt_doc}, |
| 721 | {"tan", math_tan, METH_O, math_tan_doc}, |
| 722 | {"tanh", math_tanh, METH_O, math_tanh_doc}, |
Jeffrey Yasskin | ca2b69f | 2008-02-01 06:22:46 +0000 | [diff] [blame] | 723 | {"trunc", math_trunc, METH_O, math_trunc_doc}, |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 724 | {NULL, NULL} /* sentinel */ |
| 725 | }; |
| 726 | |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 727 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 728 | PyDoc_STRVAR(module_doc, |
Tim Peters | 63c9453 | 2001-09-04 23:17:42 +0000 | [diff] [blame] | 729 | "This module is always available. It provides access to the\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 730 | "mathematical functions defined by the C standard."); |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 731 | |
Mark Hammond | fe51c6d | 2002-08-02 02:27:13 +0000 | [diff] [blame] | 732 | PyMODINIT_FUNC |
Thomas Wouters | f3f33dc | 2000-07-21 06:00:07 +0000 | [diff] [blame] | 733 | initmath(void) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 734 | { |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 735 | PyObject *m; |
Tim Peters | fe71f81 | 2001-08-07 22:10:00 +0000 | [diff] [blame] | 736 | |
Guido van Rossum | c6e2290 | 1998-12-04 19:26:43 +0000 | [diff] [blame] | 737 | m = Py_InitModule3("math", math_methods, module_doc); |
Neal Norwitz | 1ac754f | 2006-01-19 06:09:39 +0000 | [diff] [blame] | 738 | if (m == NULL) |
| 739 | goto finally; |
Barry Warsaw | fc93f75 | 1996-12-17 00:47:03 +0000 | [diff] [blame] | 740 | |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 741 | PyModule_AddObject(m, "pi", PyFloat_FromDouble(Py_MATH_PI)); |
| 742 | PyModule_AddObject(m, "e", PyFloat_FromDouble(Py_MATH_E)); |
Barry Warsaw | fc93f75 | 1996-12-17 00:47:03 +0000 | [diff] [blame] | 743 | |
Christian Heimes | 6f34109 | 2008-04-18 23:13:07 +0000 | [diff] [blame] | 744 | finally: |
Barry Warsaw | 9bfd2bf | 2000-09-01 09:01:32 +0000 | [diff] [blame] | 745 | return; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 746 | } |