7.2.5.1 Complex Numbers as C Structures

7.2.5.1 Complex Numbers as C Structures

Note that the functions which accept these structures as parameters and return them as results do so by value rather than dereferencing them through pointers. This is consistent throughout the API.

Py_complex

The C structure which corresponds to the value portion of a Python complex number object. Most of the functions for dealing with complex number objects use structures of this type as input or output values, as appropriate. It is defined as:

typedef struct {
   double real;
   double imag;
} Py_complex;

Py_complex _Py_c_sum(

Py_complex left, Py_complex right)

Return the sum of two complex numbers, using the C Py_complex representation.

Py_complex _Py_c_diff(

Py_complex left, Py_complex right)

Return the difference between two complex numbers, using the C Py_complex representation.

Py_complex _Py_c_neg(

Py_complex complex)

Return the negation of the complex number complex, using the C Py_complex representation.

Py_complex _Py_c_prod(

Py_complex left, Py_complex right)

Return the product of two complex numbers, using the C Py_complex representation.

Py_complex _Py_c_quot(

Py_complex dividend, Py_complex divisor)

Return the quotient of two complex numbers, using the C Py_complex representation.

Py_complex _Py_c_pow(

Py_complex num, Py_complex exp)

Return the exponentiation of num by exp, using the C Py_complex representation.

---

Python/C API Reference Manual

Previous: 7.2.5 Complex Number Objects Up: 7.2.5 Complex Number Objects Next: 7.2.5.2 Complex Numbers as

---

Release 2.4.1, documentation updated on 30 March 2005.