blob: 9a66c0c593eda484e3912357e9850fd253003f94 [file] [log] [blame]
Guido van Rossum96783941997-05-20 18:21:34 +00001
Guido van Rossumf9fca921996-01-12 00:47:05 +00002/* Complex object implementation */
3
4/* Borrows heavily from floatobject.c */
5
Guido van Rossum96783941997-05-20 18:21:34 +00006/* Submitted by Jim Hugunin */
7
Guido van Rossumf9fca921996-01-12 00:47:05 +00008#ifndef WITHOUT_COMPLEX
9
Guido van Rossumc0b618a1997-05-02 03:12:38 +000010#include "Python.h"
Tim Peters6d6c1a32001-08-02 04:15:00 +000011#include "structmember.h"
Guido van Rossumf9fca921996-01-12 00:47:05 +000012
Tim Peters70695122001-03-11 08:37:29 +000013/* Precisions used by repr() and str(), respectively.
14
15 The repr() precision (17 significant decimal digits) is the minimal number
16 that is guaranteed to have enough precision so that if the number is read
17 back in the exact same binary value is recreated. This is true for IEEE
18 floating point by design, and also happens to work for all other modern
19 hardware.
20
21 The str() precision is chosen so that in most cases, the rounding noise
22 created by various operations is suppressed, while giving plenty of
23 precision for practical use.
24*/
25
26#define PREC_REPR 17
27#define PREC_STR 12
Guido van Rossumf9fca921996-01-12 00:47:05 +000028
29/* elementary operations on complex numbers */
30
Guido van Rossum9e720e31996-07-21 02:31:35 +000031static Py_complex c_1 = {1., 0.};
Guido van Rossumf9fca921996-01-12 00:47:05 +000032
Tim Peters0f336042001-03-18 08:21:57 +000033Py_complex
34c_sum(Py_complex a, Py_complex b)
Guido van Rossumf9fca921996-01-12 00:47:05 +000035{
Guido van Rossum9e720e31996-07-21 02:31:35 +000036 Py_complex r;
Guido van Rossumf9fca921996-01-12 00:47:05 +000037 r.real = a.real + b.real;
38 r.imag = a.imag + b.imag;
39 return r;
40}
41
Tim Peters0f336042001-03-18 08:21:57 +000042Py_complex
43c_diff(Py_complex a, Py_complex b)
Guido van Rossumf9fca921996-01-12 00:47:05 +000044{
Guido van Rossum9e720e31996-07-21 02:31:35 +000045 Py_complex r;
Guido van Rossumf9fca921996-01-12 00:47:05 +000046 r.real = a.real - b.real;
47 r.imag = a.imag - b.imag;
48 return r;
49}
50
Tim Peters0f336042001-03-18 08:21:57 +000051Py_complex
52c_neg(Py_complex a)
Guido van Rossumf9fca921996-01-12 00:47:05 +000053{
Guido van Rossum9e720e31996-07-21 02:31:35 +000054 Py_complex r;
Guido van Rossumf9fca921996-01-12 00:47:05 +000055 r.real = -a.real;
56 r.imag = -a.imag;
57 return r;
58}
59
Tim Peters0f336042001-03-18 08:21:57 +000060Py_complex
61c_prod(Py_complex a, Py_complex b)
Guido van Rossumf9fca921996-01-12 00:47:05 +000062{
Guido van Rossum9e720e31996-07-21 02:31:35 +000063 Py_complex r;
Guido van Rossumf9fca921996-01-12 00:47:05 +000064 r.real = a.real*b.real - a.imag*b.imag;
65 r.imag = a.real*b.imag + a.imag*b.real;
66 return r;
67}
68
Tim Peters0f336042001-03-18 08:21:57 +000069Py_complex
70c_quot(Py_complex a, Py_complex b)
Guido van Rossumf9fca921996-01-12 00:47:05 +000071{
Tim Peters0f336042001-03-18 08:21:57 +000072 /******************************************************************
73 This was the original algorithm. It's grossly prone to spurious
74 overflow and underflow errors. It also merrily divides by 0 despite
75 checking for that(!). The code still serves a doc purpose here, as
76 the algorithm following is a simple by-cases transformation of this
77 one:
78
Guido van Rossum9e720e31996-07-21 02:31:35 +000079 Py_complex r;
Guido van Rossumf9fca921996-01-12 00:47:05 +000080 double d = b.real*b.real + b.imag*b.imag;
81 if (d == 0.)
Guido van Rossum96783941997-05-20 18:21:34 +000082 errno = EDOM;
Guido van Rossumf9fca921996-01-12 00:47:05 +000083 r.real = (a.real*b.real + a.imag*b.imag)/d;
84 r.imag = (a.imag*b.real - a.real*b.imag)/d;
85 return r;
Tim Peters0f336042001-03-18 08:21:57 +000086 ******************************************************************/
87
88 /* This algorithm is better, and is pretty obvious: first divide the
89 * numerators and denominator by whichever of {b.real, b.imag} has
90 * larger magnitude. The earliest reference I found was to CACM
91 * Algorithm 116 (Complex Division, Robert L. Smith, Stanford
92 * University). As usual, though, we're still ignoring all IEEE
93 * endcases.
94 */
95 Py_complex r; /* the result */
96 const double abs_breal = b.real < 0 ? -b.real : b.real;
97 const double abs_bimag = b.imag < 0 ? -b.imag : b.imag;
98
99 if (abs_breal >= abs_bimag) {
100 /* divide tops and bottom by b.real */
101 if (abs_breal == 0.0) {
102 errno = EDOM;
103 r.real = r.imag = 0.0;
104 }
105 else {
106 const double ratio = b.imag / b.real;
107 const double denom = b.real + b.imag * ratio;
108 r.real = (a.real + a.imag * ratio) / denom;
109 r.imag = (a.imag - a.real * ratio) / denom;
110 }
111 }
112 else {
113 /* divide tops and bottom by b.imag */
114 const double ratio = b.real / b.imag;
115 const double denom = b.real * ratio + b.imag;
116 assert(b.imag != 0.0);
117 r.real = (a.real * ratio + a.imag) / denom;
118 r.imag = (a.imag * ratio - a.real) / denom;
119 }
120 return r;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000121}
122
Tim Peters0f336042001-03-18 08:21:57 +0000123Py_complex
124c_pow(Py_complex a, Py_complex b)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000125{
Guido van Rossum9e720e31996-07-21 02:31:35 +0000126 Py_complex r;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000127 double vabs,len,at,phase;
128 if (b.real == 0. && b.imag == 0.) {
129 r.real = 1.;
130 r.imag = 0.;
131 }
132 else if (a.real == 0. && a.imag == 0.) {
133 if (b.imag != 0. || b.real < 0.)
Guido van Rossum96783941997-05-20 18:21:34 +0000134 errno = ERANGE;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000135 r.real = 0.;
136 r.imag = 0.;
137 }
138 else {
139 vabs = hypot(a.real,a.imag);
140 len = pow(vabs,b.real);
141 at = atan2(a.imag, a.real);
142 phase = at*b.real;
143 if (b.imag != 0.0) {
144 len /= exp(at*b.imag);
145 phase += b.imag*log(vabs);
146 }
147 r.real = len*cos(phase);
148 r.imag = len*sin(phase);
149 }
150 return r;
151}
152
Tim Peters0f336042001-03-18 08:21:57 +0000153static Py_complex
154c_powu(Py_complex x, long n)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000155{
Guido van Rossum926518b1996-08-19 19:30:45 +0000156 Py_complex r, p;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000157 long mask = 1;
Guido van Rossum926518b1996-08-19 19:30:45 +0000158 r = c_1;
159 p = x;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000160 while (mask > 0 && n >= mask) {
161 if (n & mask)
162 r = c_prod(r,p);
163 mask <<= 1;
164 p = c_prod(p,p);
165 }
166 return r;
167}
168
Tim Peters0f336042001-03-18 08:21:57 +0000169static Py_complex
170c_powi(Py_complex x, long n)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000171{
Guido van Rossum9e720e31996-07-21 02:31:35 +0000172 Py_complex cn;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000173
174 if (n > 100 || n < -100) {
175 cn.real = (double) n;
176 cn.imag = 0.;
177 return c_pow(x,cn);
178 }
179 else if (n > 0)
180 return c_powu(x,n);
181 else
182 return c_quot(c_1,c_powu(x,-n));
183
184}
185
Tim Peters6d6c1a32001-08-02 04:15:00 +0000186static PyObject *
187complex_subtype_from_c_complex(PyTypeObject *type, Py_complex cval)
188{
189 PyObject *op;
190
191 op = PyType_GenericAlloc(type, 0);
192 if (op != NULL)
193 ((PyComplexObject *)op)->cval = cval;
194 return op;
195}
196
Guido van Rossumf9fca921996-01-12 00:47:05 +0000197PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000198PyComplex_FromCComplex(Py_complex cval)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000199{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000200 register PyComplexObject *op;
201
202 /* PyObject_New is inlined */
203 op = (PyComplexObject *) PyObject_MALLOC(sizeof(PyComplexObject));
Guido van Rossumf9fca921996-01-12 00:47:05 +0000204 if (op == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000205 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000206 PyObject_INIT(op, &PyComplex_Type);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000207 op->cval = cval;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000208 return (PyObject *) op;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000209}
210
Tim Peters6d6c1a32001-08-02 04:15:00 +0000211static PyObject *
212complex_subtype_from_doubles(PyTypeObject *type, double real, double imag)
213{
214 Py_complex c;
215 c.real = real;
216 c.imag = imag;
217 return complex_subtype_from_c_complex(type, c);
218}
219
Guido van Rossumf9fca921996-01-12 00:47:05 +0000220PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000221PyComplex_FromDoubles(double real, double imag)
Guido van Rossum926518b1996-08-19 19:30:45 +0000222{
223 Py_complex c;
224 c.real = real;
225 c.imag = imag;
226 return PyComplex_FromCComplex(c);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000227}
228
229double
Fred Drake4288c802000-07-09 04:36:04 +0000230PyComplex_RealAsDouble(PyObject *op)
Guido van Rossum926518b1996-08-19 19:30:45 +0000231{
232 if (PyComplex_Check(op)) {
233 return ((PyComplexObject *)op)->cval.real;
Fred Drake4288c802000-07-09 04:36:04 +0000234 }
235 else {
Guido van Rossum926518b1996-08-19 19:30:45 +0000236 return PyFloat_AsDouble(op);
237 }
Guido van Rossumf9fca921996-01-12 00:47:05 +0000238}
239
240double
Fred Drake4288c802000-07-09 04:36:04 +0000241PyComplex_ImagAsDouble(PyObject *op)
Guido van Rossum926518b1996-08-19 19:30:45 +0000242{
243 if (PyComplex_Check(op)) {
244 return ((PyComplexObject *)op)->cval.imag;
Fred Drake4288c802000-07-09 04:36:04 +0000245 }
246 else {
Guido van Rossum926518b1996-08-19 19:30:45 +0000247 return 0.0;
248 }
Guido van Rossumf9fca921996-01-12 00:47:05 +0000249}
250
Guido van Rossum9e720e31996-07-21 02:31:35 +0000251Py_complex
Fred Drake4288c802000-07-09 04:36:04 +0000252PyComplex_AsCComplex(PyObject *op)
Guido van Rossum926518b1996-08-19 19:30:45 +0000253{
Guido van Rossum9e720e31996-07-21 02:31:35 +0000254 Py_complex cv;
Guido van Rossumcf3d1081996-01-12 01:21:14 +0000255 if (PyComplex_Check(op)) {
256 return ((PyComplexObject *)op)->cval;
Fred Drake4288c802000-07-09 04:36:04 +0000257 }
258 else {
Guido van Rossumcf3d1081996-01-12 01:21:14 +0000259 cv.real = PyFloat_AsDouble(op);
260 cv.imag = 0.;
261 return cv;
Tim Peters70695122001-03-11 08:37:29 +0000262 }
Guido van Rossumcf3d1081996-01-12 01:21:14 +0000263}
264
Guido van Rossumf9fca921996-01-12 00:47:05 +0000265static void
Fred Drake4288c802000-07-09 04:36:04 +0000266complex_dealloc(PyObject *op)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000267{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000268 PyObject_DEL(op);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000269}
270
271
Guido van Rossum363078a1996-05-24 20:45:01 +0000272static void
Tim Peters70695122001-03-11 08:37:29 +0000273complex_to_buf(char *buf, PyComplexObject *v, int precision)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000274{
275 if (v->cval.real == 0.)
Tim Peters70695122001-03-11 08:37:29 +0000276 sprintf(buf, "%.*gj", precision, v->cval.imag);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000277 else
Tim Peters70695122001-03-11 08:37:29 +0000278 sprintf(buf, "(%.*g%+.*gj)", precision, v->cval.real,
279 precision, v->cval.imag);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000280}
281
282static int
Fred Drake4288c802000-07-09 04:36:04 +0000283complex_print(PyComplexObject *v, FILE *fp, int flags)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000284{
285 char buf[100];
Tim Peters70695122001-03-11 08:37:29 +0000286 complex_to_buf(buf, v,
287 (flags & Py_PRINT_RAW) ? PREC_STR : PREC_REPR);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000288 fputs(buf, fp);
289 return 0;
290}
291
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000292static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000293complex_repr(PyComplexObject *v)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000294{
295 char buf[100];
Tim Peters70695122001-03-11 08:37:29 +0000296 complex_to_buf(buf, v, PREC_REPR);
297 return PyString_FromString(buf);
298}
299
300static PyObject *
301complex_str(PyComplexObject *v)
302{
303 char buf[100];
304 complex_to_buf(buf, v, PREC_STR);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000305 return PyString_FromString(buf);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000306}
307
Guido van Rossumf9fca921996-01-12 00:47:05 +0000308static long
Fred Drake4288c802000-07-09 04:36:04 +0000309complex_hash(PyComplexObject *v)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000310{
Tim Peters39dce292000-08-15 03:34:48 +0000311 long hashreal, hashimag, combined;
312 hashreal = _Py_HashDouble(v->cval.real);
313 if (hashreal == -1)
314 return -1;
315 hashimag = _Py_HashDouble(v->cval.imag);
316 if (hashimag == -1)
317 return -1;
318 /* Note: if the imaginary part is 0, hashimag is 0 now,
319 * so the following returns hashreal unchanged. This is
320 * important because numbers of different types that
321 * compare equal must have the same hash value, so that
322 * hash(x + 0*j) must equal hash(x).
323 */
324 combined = hashreal + 1000003 * hashimag;
325 if (combined == -1)
326 combined = -2;
327 return combined;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000328}
329
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000330static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000331complex_add(PyComplexObject *v, PyComplexObject *w)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000332{
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000333 Py_complex result;
334 PyFPE_START_PROTECT("complex_add", return 0)
335 result = c_sum(v->cval,w->cval);
Guido van Rossum45b83911997-03-14 04:32:50 +0000336 PyFPE_END_PROTECT(result)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000337 return PyComplex_FromCComplex(result);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000338}
339
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000340static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000341complex_sub(PyComplexObject *v, PyComplexObject *w)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000342{
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000343 Py_complex result;
344 PyFPE_START_PROTECT("complex_sub", return 0)
345 result = c_diff(v->cval,w->cval);
Guido van Rossum45b83911997-03-14 04:32:50 +0000346 PyFPE_END_PROTECT(result)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000347 return PyComplex_FromCComplex(result);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000348}
349
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000350static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000351complex_mul(PyComplexObject *v, PyComplexObject *w)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000352{
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000353 Py_complex result;
354 PyFPE_START_PROTECT("complex_mul", return 0)
355 result = c_prod(v->cval,w->cval);
Guido van Rossum45b83911997-03-14 04:32:50 +0000356 PyFPE_END_PROTECT(result)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000357 return PyComplex_FromCComplex(result);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000358}
359
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000360static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000361complex_div(PyComplexObject *v, PyComplexObject *w)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000362{
Guido van Rossum9e720e31996-07-21 02:31:35 +0000363 Py_complex quot;
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000364 PyFPE_START_PROTECT("complex_div", return 0)
Guido van Rossum96783941997-05-20 18:21:34 +0000365 errno = 0;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000366 quot = c_quot(v->cval,w->cval);
Guido van Rossum45b83911997-03-14 04:32:50 +0000367 PyFPE_END_PROTECT(quot)
Guido van Rossum96783941997-05-20 18:21:34 +0000368 if (errno == EDOM) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000369 PyErr_SetString(PyExc_ZeroDivisionError, "complex division");
Guido van Rossumf9fca921996-01-12 00:47:05 +0000370 return NULL;
371 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000372 return PyComplex_FromCComplex(quot);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000373}
374
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000375static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000376complex_remainder(PyComplexObject *v, PyComplexObject *w)
Guido van Rossumee09fc11996-09-11 13:55:55 +0000377{
Guido van Rossum3be12e91996-09-12 20:56:18 +0000378 Py_complex div, mod;
Guido van Rossum96783941997-05-20 18:21:34 +0000379 errno = 0;
Guido van Rossum3be12e91996-09-12 20:56:18 +0000380 div = c_quot(v->cval,w->cval); /* The raw divisor value. */
Guido van Rossum96783941997-05-20 18:21:34 +0000381 if (errno == EDOM) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000382 PyErr_SetString(PyExc_ZeroDivisionError, "complex remainder");
Guido van Rossum3be12e91996-09-12 20:56:18 +0000383 return NULL;
384 }
385 div.real = floor(div.real); /* Use the floor of the real part. */
386 div.imag = 0.0;
387 mod = c_diff(v->cval, c_prod(w->cval, div));
388
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000389 return PyComplex_FromCComplex(mod);
Guido van Rossumee09fc11996-09-11 13:55:55 +0000390}
391
Guido van Rossumee09fc11996-09-11 13:55:55 +0000392
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000393static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000394complex_divmod(PyComplexObject *v, PyComplexObject *w)
Guido van Rossum3be12e91996-09-12 20:56:18 +0000395{
396 Py_complex div, mod;
397 PyObject *d, *m, *z;
Guido van Rossum96783941997-05-20 18:21:34 +0000398 errno = 0;
Guido van Rossum3be12e91996-09-12 20:56:18 +0000399 div = c_quot(v->cval,w->cval); /* The raw divisor value. */
Guido van Rossum96783941997-05-20 18:21:34 +0000400 if (errno == EDOM) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000401 PyErr_SetString(PyExc_ZeroDivisionError, "complex divmod()");
Guido van Rossum3be12e91996-09-12 20:56:18 +0000402 return NULL;
403 }
404 div.real = floor(div.real); /* Use the floor of the real part. */
405 div.imag = 0.0;
406 mod = c_diff(v->cval, c_prod(w->cval, div));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000407 d = PyComplex_FromCComplex(div);
408 m = PyComplex_FromCComplex(mod);
409 z = Py_BuildValue("(OO)", d, m);
Guido van Rossum3be12e91996-09-12 20:56:18 +0000410 Py_XDECREF(d);
411 Py_XDECREF(m);
412 return z;
413}
Guido van Rossumf9fca921996-01-12 00:47:05 +0000414
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000415static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000416complex_pow(PyComplexObject *v, PyObject *w, PyComplexObject *z)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000417{
Guido van Rossum9e720e31996-07-21 02:31:35 +0000418 Py_complex p;
419 Py_complex exponent;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000420 long int_exponent;
421
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000422 if ((PyObject *)z!=Py_None) {
423 PyErr_SetString(PyExc_ValueError, "complex modulo");
Guido van Rossumf9fca921996-01-12 00:47:05 +0000424 return NULL;
425 }
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000426 PyFPE_START_PROTECT("complex_pow", return 0)
Guido van Rossum96783941997-05-20 18:21:34 +0000427 errno = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000428 exponent = ((PyComplexObject*)w)->cval;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000429 int_exponent = (long)exponent.real;
430 if (exponent.imag == 0. && exponent.real == int_exponent)
431 p = c_powi(v->cval,int_exponent);
432 else
433 p = c_pow(v->cval,exponent);
434
Guido van Rossum45b83911997-03-14 04:32:50 +0000435 PyFPE_END_PROTECT(p)
Guido van Rossum96783941997-05-20 18:21:34 +0000436 if (errno == ERANGE) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000437 PyErr_SetString(PyExc_ValueError,
438 "0.0 to a negative or complex power");
Guido van Rossumf9fca921996-01-12 00:47:05 +0000439 return NULL;
440 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000441 return PyComplex_FromCComplex(p);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000442}
443
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000444static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000445complex_neg(PyComplexObject *v)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000446{
Guido van Rossum9e720e31996-07-21 02:31:35 +0000447 Py_complex neg;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000448 neg.real = -v->cval.real;
449 neg.imag = -v->cval.imag;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000450 return PyComplex_FromCComplex(neg);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000451}
452
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000453static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000454complex_pos(PyComplexObject *v)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000455{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000456 Py_INCREF(v);
457 return (PyObject *)v;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000458}
459
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000460static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000461complex_abs(PyComplexObject *v)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000462{
Guido van Rossum09e6ad01997-02-14 22:54:21 +0000463 double result;
464 PyFPE_START_PROTECT("complex_abs", return 0)
465 result = hypot(v->cval.real,v->cval.imag);
Guido van Rossum45b83911997-03-14 04:32:50 +0000466 PyFPE_END_PROTECT(result)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000467 return PyFloat_FromDouble(result);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000468}
469
470static int
Fred Drake4288c802000-07-09 04:36:04 +0000471complex_nonzero(PyComplexObject *v)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000472{
Guido van Rossum3bbef601999-01-25 19:42:19 +0000473 return v->cval.real != 0.0 || v->cval.imag != 0.0;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000474}
475
476static int
Fred Drake4288c802000-07-09 04:36:04 +0000477complex_coerce(PyObject **pv, PyObject **pw)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000478{
Guido van Rossum9e720e31996-07-21 02:31:35 +0000479 Py_complex cval;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000480 cval.imag = 0.;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000481 if (PyInt_Check(*pw)) {
482 cval.real = (double)PyInt_AsLong(*pw);
483 *pw = PyComplex_FromCComplex(cval);
484 Py_INCREF(*pv);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000485 return 0;
486 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000487 else if (PyLong_Check(*pw)) {
488 cval.real = PyLong_AsDouble(*pw);
489 *pw = PyComplex_FromCComplex(cval);
490 Py_INCREF(*pv);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000491 return 0;
492 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000493 else if (PyFloat_Check(*pw)) {
494 cval.real = PyFloat_AsDouble(*pw);
495 *pw = PyComplex_FromCComplex(cval);
496 Py_INCREF(*pv);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000497 return 0;
498 }
499 return 1; /* Can't do it */
500}
501
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000502static PyObject *
Guido van Rossumbe4cbb12001-01-18 01:12:39 +0000503complex_richcompare(PyObject *v, PyObject *w, int op)
504{
505 int c;
506 Py_complex i, j;
507 PyObject *res;
508
509 if (op != Py_EQ && op != Py_NE) {
510 PyErr_SetString(PyExc_TypeError,
511 "cannot compare complex numbers using <, <=, >, >=");
512 return NULL;
513 }
514
515 c = PyNumber_CoerceEx(&v, &w);
516 if (c < 0)
517 return NULL;
518 if (c > 0) {
519 Py_INCREF(Py_NotImplemented);
520 return Py_NotImplemented;
521 }
522 if (!PyComplex_Check(v) || !PyComplex_Check(w)) {
523 Py_DECREF(v);
524 Py_DECREF(w);
525 Py_INCREF(Py_NotImplemented);
526 return Py_NotImplemented;
527 }
528
529 i = ((PyComplexObject *)v)->cval;
530 j = ((PyComplexObject *)w)->cval;
531 Py_DECREF(v);
532 Py_DECREF(w);
533
534 if ((i.real == j.real && i.imag == j.imag) == (op == Py_EQ))
535 res = Py_True;
536 else
537 res = Py_False;
538
539 Py_INCREF(res);
540 return res;
541}
542
543static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000544complex_int(PyObject *v)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000545{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000546 PyErr_SetString(PyExc_TypeError,
Guido van Rossumd4ab3cd1996-09-11 22:54:37 +0000547 "can't convert complex to int; use e.g. int(abs(z))");
548 return NULL;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000549}
550
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000551static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000552complex_long(PyObject *v)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000553{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000554 PyErr_SetString(PyExc_TypeError,
Guido van Rossumd4ab3cd1996-09-11 22:54:37 +0000555 "can't convert complex to long; use e.g. long(abs(z))");
556 return NULL;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000557}
558
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000559static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000560complex_float(PyObject *v)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000561{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000562 PyErr_SetString(PyExc_TypeError,
Guido van Rossumd4ab3cd1996-09-11 22:54:37 +0000563 "can't convert complex to float; use e.g. abs(z)");
564 return NULL;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000565}
566
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000567static PyObject *
Fred Drake4288c802000-07-09 04:36:04 +0000568complex_conjugate(PyObject *self, PyObject *args)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000569{
Guido van Rossum926518b1996-08-19 19:30:45 +0000570 Py_complex c;
Guido van Rossum43713e52000-02-29 13:59:29 +0000571 if (!PyArg_ParseTuple(args, ":conjugate"))
Guido van Rossum8530ef61998-05-07 16:29:10 +0000572 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000573 c = ((PyComplexObject *)self)->cval;
Guido van Rossumf9fca921996-01-12 00:47:05 +0000574 c.imag = -c.imag;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000575 return PyComplex_FromCComplex(c);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000576}
577
578static PyMethodDef complex_methods[] = {
Guido van Rossum8530ef61998-05-07 16:29:10 +0000579 {"conjugate", complex_conjugate, 1},
Guido van Rossumf9fca921996-01-12 00:47:05 +0000580 {NULL, NULL} /* sentinel */
581};
582
Tim Peters6d6c1a32001-08-02 04:15:00 +0000583static struct memberlist complex_members[] = {
584 {"real", T_DOUBLE, offsetof(PyComplexObject, cval.real), 0},
585 {"imag", T_DOUBLE, offsetof(PyComplexObject, cval.imag), 0},
586 {0},
587};
Guido van Rossumf9fca921996-01-12 00:47:05 +0000588
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000589static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000590complex_subtype_from_string(PyTypeObject *type, PyObject *v)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000591{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000592 extern double strtod(const char *, char **);
593 const char *s, *start;
594 char *end;
595 double x=0.0, y=0.0, z;
596 int got_re=0, got_im=0, done=0;
597 int digit_or_dot;
598 int sw_error=0;
599 int sign;
600 char buffer[256]; /* For errors */
601 char s_buffer[256];
602 int len;
603
604 if (PyString_Check(v)) {
605 s = PyString_AS_STRING(v);
606 len = PyString_GET_SIZE(v);
607 }
608 else if (PyUnicode_Check(v)) {
609 if (PyUnicode_GET_SIZE(v) >= sizeof(s_buffer)) {
610 PyErr_SetString(PyExc_ValueError,
611 "complex() literal too large to convert");
612 return NULL;
613 }
614 if (PyUnicode_EncodeDecimal(PyUnicode_AS_UNICODE(v),
615 PyUnicode_GET_SIZE(v),
616 s_buffer,
617 NULL))
618 return NULL;
619 s = s_buffer;
620 len = (int)strlen(s);
621 }
622 else if (PyObject_AsCharBuffer(v, &s, &len)) {
623 PyErr_SetString(PyExc_TypeError,
624 "complex() arg is not a string");
625 return NULL;
626 }
627
628 /* position on first nonblank */
629 start = s;
630 while (*s && isspace(Py_CHARMASK(*s)))
631 s++;
632 if (s[0] == '\0') {
633 PyErr_SetString(PyExc_ValueError,
634 "complex() arg is an empty string");
635 return NULL;
636 }
637
638 z = -1.0;
639 sign = 1;
640 do {
641
642 switch (*s) {
643
644 case '\0':
645 if (s-start != len) {
646 PyErr_SetString(
647 PyExc_ValueError,
648 "complex() arg contains a null byte");
649 return NULL;
650 }
651 if(!done) sw_error=1;
652 break;
653
654 case '-':
655 sign = -1;
656 /* Fallthrough */
657 case '+':
658 if (done) sw_error=1;
659 s++;
660 if ( *s=='\0'||*s=='+'||*s=='-' ||
661 isspace(Py_CHARMASK(*s)) ) sw_error=1;
662 break;
663
664 case 'J':
665 case 'j':
666 if (got_im || done) {
667 sw_error = 1;
668 break;
669 }
670 if (z<0.0) {
671 y=sign;
672 }
673 else{
674 y=sign*z;
675 }
676 got_im=1;
677 s++;
678 if (*s!='+' && *s!='-' )
679 done=1;
680 break;
681
682 default:
683 if (isspace(Py_CHARMASK(*s))) {
684 while (*s && isspace(Py_CHARMASK(*s)))
685 s++;
686 if (s[0] != '\0')
687 sw_error=1;
688 else
689 done = 1;
690 break;
691 }
692 digit_or_dot =
693 (*s=='.' || isdigit(Py_CHARMASK(*s)));
694 if (done||!digit_or_dot) {
695 sw_error=1;
696 break;
697 }
698 errno = 0;
699 PyFPE_START_PROTECT("strtod", return 0)
700 z = strtod(s, &end) ;
701 PyFPE_END_PROTECT(z)
702 if (errno != 0) {
703 sprintf(buffer,
704 "float() out of range: %.150s", s);
705 PyErr_SetString(
706 PyExc_ValueError,
707 buffer);
708 return NULL;
709 }
710 s=end;
711 if (*s=='J' || *s=='j') {
712
713 break;
714 }
715 if (got_re) {
716 sw_error=1;
717 break;
718 }
719
720 /* accept a real part */
721 x=sign*z;
722 got_re=1;
723 if (got_im) done=1;
724 z = -1.0;
725 sign = 1;
726 break;
727
728 } /* end of switch */
729
730 } while (*s!='\0' && !sw_error);
731
732 if (sw_error) {
733 PyErr_SetString(PyExc_ValueError,
734 "complex() arg is a malformed string");
735 return NULL;
736 }
737
738 return complex_subtype_from_doubles(type, x, y);
Guido van Rossumf9fca921996-01-12 00:47:05 +0000739}
740
Tim Peters6d6c1a32001-08-02 04:15:00 +0000741static PyObject *
742complex_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
743{
744 PyObject *r, *i, *tmp;
745 PyNumberMethods *nbr, *nbi = NULL;
746 Py_complex cr, ci;
747 int own_r = 0;
748 static char *kwlist[] = {"real", "imag", 0};
749
750 r = Py_False;
751 i = NULL;
752 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OO:complex", kwlist,
753 &r, &i))
754 return NULL;
755 if (PyString_Check(r) || PyUnicode_Check(r))
756 return complex_subtype_from_string(type, r);
757 if ((nbr = r->ob_type->tp_as_number) == NULL ||
758 nbr->nb_float == NULL ||
759 (i != NULL &&
760 ((nbi = i->ob_type->tp_as_number) == NULL ||
761 nbi->nb_float == NULL))) {
762 PyErr_SetString(PyExc_TypeError,
763 "complex() arg can't be converted to complex");
764 return NULL;
765 }
766 /* XXX Hack to support classes with __complex__ method */
767 if (PyInstance_Check(r)) {
768 static PyObject *complexstr;
769 PyObject *f;
770 if (complexstr == NULL) {
771 complexstr = PyString_InternFromString("__complex__");
772 if (complexstr == NULL)
773 return NULL;
774 }
775 f = PyObject_GetAttr(r, complexstr);
776 if (f == NULL)
777 PyErr_Clear();
778 else {
779 PyObject *args = Py_BuildValue("()");
780 if (args == NULL)
781 return NULL;
782 r = PyEval_CallObject(f, args);
783 Py_DECREF(args);
784 Py_DECREF(f);
785 if (r == NULL)
786 return NULL;
787 own_r = 1;
788 }
789 }
790 if (PyComplex_Check(r)) {
791 cr = ((PyComplexObject*)r)->cval;
792 if (own_r) {
793 Py_DECREF(r);
794 }
795 }
796 else {
797 tmp = PyNumber_Float(r);
798 if (own_r) {
799 Py_DECREF(r);
800 }
801 if (tmp == NULL)
802 return NULL;
803 if (!PyFloat_Check(tmp)) {
804 PyErr_SetString(PyExc_TypeError,
805 "float(r) didn't return a float");
806 Py_DECREF(tmp);
807 return NULL;
808 }
809 cr.real = PyFloat_AsDouble(tmp);
810 Py_DECREF(tmp);
811 cr.imag = 0.0;
812 }
813 if (i == NULL) {
814 ci.real = 0.0;
815 ci.imag = 0.0;
816 }
817 else if (PyComplex_Check(i))
818 ci = ((PyComplexObject*)i)->cval;
819 else {
820 tmp = (*nbi->nb_float)(i);
821 if (tmp == NULL)
822 return NULL;
823 ci.real = PyFloat_AsDouble(tmp);
824 Py_DECREF(tmp);
825 ci.imag = 0.;
826 }
827 cr.real -= ci.imag;
828 cr.imag += ci.real;
829 return complex_subtype_from_c_complex(type, cr);
830}
831
832static char complex_doc[] =
833"complex(real[, imag]) -> complex number\n\
834\n\
835Create a complex number from a real part and an optional imaginary part.\n\
836This is equivalent to (real + imag*1j) where imag defaults to 0.";
837
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000838static PyNumberMethods complex_as_number = {
Guido van Rossumbe4cbb12001-01-18 01:12:39 +0000839 (binaryfunc)complex_add, /* nb_add */
840 (binaryfunc)complex_sub, /* nb_subtract */
841 (binaryfunc)complex_mul, /* nb_multiply */
842 (binaryfunc)complex_div, /* nb_divide */
843 (binaryfunc)complex_remainder, /* nb_remainder */
844 (binaryfunc)complex_divmod, /* nb_divmod */
845 (ternaryfunc)complex_pow, /* nb_power */
846 (unaryfunc)complex_neg, /* nb_negative */
847 (unaryfunc)complex_pos, /* nb_positive */
848 (unaryfunc)complex_abs, /* nb_absolute */
849 (inquiry)complex_nonzero, /* nb_nonzero */
850 0, /* nb_invert */
851 0, /* nb_lshift */
852 0, /* nb_rshift */
853 0, /* nb_and */
854 0, /* nb_xor */
855 0, /* nb_or */
856 (coercion)complex_coerce, /* nb_coerce */
857 (unaryfunc)complex_int, /* nb_int */
858 (unaryfunc)complex_long, /* nb_long */
859 (unaryfunc)complex_float, /* nb_float */
860 0, /* nb_oct */
861 0, /* nb_hex */
Guido van Rossumf9fca921996-01-12 00:47:05 +0000862};
863
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000864PyTypeObject PyComplex_Type = {
865 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossumf9fca921996-01-12 00:47:05 +0000866 0,
867 "complex",
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000868 sizeof(PyComplexObject),
Guido van Rossumf9fca921996-01-12 00:47:05 +0000869 0,
Guido van Rossumbe4cbb12001-01-18 01:12:39 +0000870 (destructor)complex_dealloc, /* tp_dealloc */
871 (printfunc)complex_print, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000872 0, /* tp_getattr */
Guido van Rossumbe4cbb12001-01-18 01:12:39 +0000873 0, /* tp_setattr */
874 0, /* tp_compare */
875 (reprfunc)complex_repr, /* tp_repr */
876 &complex_as_number, /* tp_as_number */
877 0, /* tp_as_sequence */
878 0, /* tp_as_mapping */
879 (hashfunc)complex_hash, /* tp_hash */
880 0, /* tp_call */
Tim Peters70695122001-03-11 08:37:29 +0000881 (reprfunc)complex_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000882 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossumbe4cbb12001-01-18 01:12:39 +0000883 0, /* tp_setattro */
884 0, /* tp_as_buffer */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000885 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
886 complex_doc, /* tp_doc */
Guido van Rossumbe4cbb12001-01-18 01:12:39 +0000887 0, /* tp_traverse */
888 0, /* tp_clear */
889 complex_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000890 0, /* tp_weaklistoffset */
891 0, /* tp_iter */
892 0, /* tp_iternext */
893 complex_methods, /* tp_methods */
894 complex_members, /* tp_members */
895 0, /* tp_getset */
896 0, /* tp_base */
897 0, /* tp_dict */
898 0, /* tp_descr_get */
899 0, /* tp_descr_set */
900 0, /* tp_dictoffset */
901 0, /* tp_init */
902 0, /* tp_alloc */
903 complex_new, /* tp_new */
Guido van Rossumf9fca921996-01-12 00:47:05 +0000904};
905
906#endif