blob: 8290a6dc4f5eb7d1069f35c90d2d9973002fd6e9 [file] [log] [blame]
Fred Drakeea9cb5a2000-07-09 00:20:36 +00001/* Complex number structure */
2
Neal Norwitz638437f2002-10-04 12:43:02 +00003#ifndef Py_COMPLEXOBJECT_H
4#define Py_COMPLEXOBJECT_H
Guido van Rossumf9fca921996-01-12 00:47:05 +00005#ifdef __cplusplus
6extern "C" {
7#endif
8
Guido van Rossumf9fca921996-01-12 00:47:05 +00009typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000010 double real;
11 double imag;
Guido van Rossum519b4331996-07-21 02:24:22 +000012} Py_complex;
Guido van Rossumf9fca921996-01-12 00:47:05 +000013
14/* Operations on complex numbers from complexmodule.c */
15
Guido van Rossum652f1081996-05-24 21:01:36 +000016#define c_sum _Py_c_sum
17#define c_diff _Py_c_diff
18#define c_neg _Py_c_neg
19#define c_prod _Py_c_prod
20#define c_quot _Py_c_quot
21#define c_pow _Py_c_pow
Christian Heimes53876d92008-04-19 00:31:39 +000022#define c_abs _Py_c_abs
Guido van Rossum652f1081996-05-24 21:01:36 +000023
Mark Hammond91a681d2002-08-12 07:21:58 +000024PyAPI_FUNC(Py_complex) c_sum(Py_complex, Py_complex);
25PyAPI_FUNC(Py_complex) c_diff(Py_complex, Py_complex);
26PyAPI_FUNC(Py_complex) c_neg(Py_complex);
27PyAPI_FUNC(Py_complex) c_prod(Py_complex, Py_complex);
28PyAPI_FUNC(Py_complex) c_quot(Py_complex, Py_complex);
29PyAPI_FUNC(Py_complex) c_pow(Py_complex, Py_complex);
Christian Heimes53876d92008-04-19 00:31:39 +000030PyAPI_FUNC(double) c_abs(Py_complex);
Guido van Rossumf9fca921996-01-12 00:47:05 +000031
32
33/* Complex object interface */
34
35/*
36PyComplexObject represents a complex number with double-precision
37real and imaginary parts.
38*/
39
40typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000041 PyObject_HEAD
42 Py_complex cval;
Guido van Rossumf9fca921996-01-12 00:47:05 +000043} PyComplexObject;
44
Mark Hammond91a681d2002-08-12 07:21:58 +000045PyAPI_DATA(PyTypeObject) PyComplex_Type;
Guido van Rossumf9fca921996-01-12 00:47:05 +000046
Guido van Rossumc16fcdf2001-08-29 15:45:32 +000047#define PyComplex_Check(op) PyObject_TypeCheck(op, &PyComplex_Type)
Christian Heimes90aa7642007-12-19 02:45:37 +000048#define PyComplex_CheckExact(op) (Py_TYPE(op) == &PyComplex_Type)
Guido van Rossumf9fca921996-01-12 00:47:05 +000049
Mark Hammond91a681d2002-08-12 07:21:58 +000050PyAPI_FUNC(PyObject *) PyComplex_FromCComplex(Py_complex);
51PyAPI_FUNC(PyObject *) PyComplex_FromDoubles(double real, double imag);
Guido van Rossumf9fca921996-01-12 00:47:05 +000052
Mark Hammond91a681d2002-08-12 07:21:58 +000053PyAPI_FUNC(double) PyComplex_RealAsDouble(PyObject *op);
54PyAPI_FUNC(double) PyComplex_ImagAsDouble(PyObject *op);
55PyAPI_FUNC(Py_complex) PyComplex_AsCComplex(PyObject *op);
Guido van Rossumf9fca921996-01-12 00:47:05 +000056
Eric Smith58a42242009-04-30 01:00:33 +000057/* Format the object based on the format_spec, as defined in PEP 3101
58 (Advanced String Formatting). */
59PyAPI_FUNC(PyObject *) _PyComplex_FormatAdvanced(PyObject *obj,
60 Py_UNICODE *format_spec,
61 Py_ssize_t format_spec_len);
62
Guido van Rossumf9fca921996-01-12 00:47:05 +000063#ifdef __cplusplus
64}
65#endif
Neal Norwitz638437f2002-10-04 12:43:02 +000066#endif /* !Py_COMPLEXOBJECT_H */