Gecko [ v99win.today ]

Name	Size	Permission
abstract.rst.txt	702 B	-rw-r--r--
allocation.rst.txt	4.68 KB	-rw-r--r--
arg.rst.txt	25.39 KB	-rw-r--r--
bool.rst.txt	1.27 KB	-rw-r--r--
buffer.rst.txt	22.43 KB	-rw-r--r--
bytearray.rst.txt	2.13 KB	-rw-r--r--
capsule.rst.txt	5.61 KB	-rw-r--r--
cell.rst.txt	1.89 KB	-rw-r--r--
class.rst.txt	1.82 KB	-rw-r--r--
cobject.rst.txt	1.83 KB	-rw-r--r--
code.rst.txt	1.6 KB	-rw-r--r--
codec.rst.txt	4.53 KB	-rw-r--r--
complex.rst.txt	3.98 KB	-rw-r--r--
concrete.rst.txt	1.92 KB	-rw-r--r--
conversion.rst.txt	6.93 KB	-rw-r--r--
datetime.rst.txt	6.26 KB	-rw-r--r--
descriptor.rst.txt	1.27 KB	-rw-r--r--
dict.rst.txt	7.58 KB	-rw-r--r--
exceptions.rst.txt	34.66 KB	-rw-r--r--
file.rst.txt	6.05 KB	-rw-r--r--
float.rst.txt	3.29 KB	-rw-r--r--
function.rst.txt	2.36 KB	-rw-r--r--
gcsupport.rst.txt	6.43 KB	-rw-r--r--
gen.rst.txt	920 B	-rw-r--r--
import.rst.txt	10.96 KB	-rw-r--r--
index.rst.txt	578 B	-rw-r--r--
init.rst.txt	48.01 KB	-rw-r--r--
int.rst.txt	4.47 KB	-rw-r--r--
intro.rst.txt	27.81 KB	-rw-r--r--
iter.rst.txt	1.36 KB	-rw-r--r--
iterator.rst.txt	1.75 KB	-rw-r--r--
list.rst.txt	6.27 KB	-rw-r--r--
long.rst.txt	7.99 KB	-rw-r--r--
mapping.rst.txt	2.81 KB	-rw-r--r--
marshal.rst.txt	3.89 KB	-rw-r--r--
memory.rst.txt	11.29 KB	-rw-r--r--
method.rst.txt	2.05 KB	-rw-r--r--
module.rst.txt	3.78 KB	-rw-r--r--
none.rst.txt	697 B	-rw-r--r--
number.rst.txt	11.66 KB	-rw-r--r--
objbuffer.rst.txt	2.46 KB	-rw-r--r--
object.rst.txt	17.08 KB	-rw-r--r--
objimpl.rst.txt	305 B	-rw-r--r--
refcounting.rst.txt	2.87 KB	-rw-r--r--
reflection.rst.txt	1.53 KB	-rw-r--r--
sequence.rst.txt	8.51 KB	-rw-r--r--
set.rst.txt	6.43 KB	-rw-r--r--
slice.rst.txt	2.91 KB	-rw-r--r--
string.rst.txt	15.06 KB	-rw-r--r--
structures.rst.txt	14.62 KB	-rw-r--r--
sys.rst.txt	5.58 KB	-rw-r--r--
tuple.rst.txt	5.83 KB	-rw-r--r--
type.rst.txt	2.7 KB	-rw-r--r--
typeobj.rst.txt	65.37 KB	-rw-r--r--
unicode.rst.txt	44.07 KB	-rw-r--r--
utilities.rst.txt	415 B	-rw-r--r--
veryhigh.rst.txt	13.05 KB	-rw-r--r--
weakref.rst.txt	2.75 KB	-rw-r--r--

Code Editor : complex.rst.txt

.. highlightlang:: c

.. _complexobjects:

Complex Number Objects
----------------------

.. index:: object: complex number

Python's complex number objects are implemented as two distinct types when
viewed from the C API:  one is the Python object exposed to Python programs, and
the other is a C structure which represents the actual complex number value.
The API provides functions for working with both.

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.

.. c:type:: 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;

.. c:function:: Py_complex _Py_c_sum(Py_complex left, Py_complex right)

Return the sum of two complex numbers, using the C :c:type:`Py_complex`
   representation.

.. c:function:: Py_complex _Py_c_diff(Py_complex left, Py_complex right)

Return the difference between two complex numbers, using the C
   :c:type:`Py_complex` representation.

.. c:function:: Py_complex _Py_c_neg(Py_complex complex)

Return the negation of the complex number *complex*, using the C
   :c:type:`Py_complex` representation.

.. c:function:: Py_complex _Py_c_prod(Py_complex left, Py_complex right)

Return the product of two complex numbers, using the C :c:type:`Py_complex`
   representation.

.. c:function:: Py_complex _Py_c_quot(Py_complex dividend, Py_complex divisor)

Return the quotient of two complex numbers, using the C :c:type:`Py_complex`
   representation.

If *divisor* is null, this method returns zero and sets
   :c:data:`errno` to :c:data:`EDOM`.

.. c:function:: Py_complex _Py_c_pow(Py_complex num, Py_complex exp)

Return the exponentiation of *num* by *exp*, using the C :c:type:`Py_complex`
   representation.

If *num* is null and *exp* is not a positive real number,
   this method returns zero and sets :c:data:`errno` to :c:data:`EDOM`.

Complex Numbers as Python Objects
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. c:type:: PyComplexObject

This subtype of :c:type:`PyObject` represents a Python complex number object.

.. c:var:: PyTypeObject PyComplex_Type

This instance of :c:type:`PyTypeObject` represents the Python complex number
   type. It is the same object as ``complex`` and ``types.ComplexType``.

.. c:function:: int PyComplex_Check(PyObject *p)

Return true if its argument is a :c:type:`PyComplexObject` or a subtype of
   :c:type:`PyComplexObject`.

.. versionchanged:: 2.2
      Allowed subtypes to be accepted.

.. c:function:: int PyComplex_CheckExact(PyObject *p)

Return true if its argument is a :c:type:`PyComplexObject`, but not a subtype of
   :c:type:`PyComplexObject`.

.. versionadded:: 2.2

.. c:function:: PyObject* PyComplex_FromCComplex(Py_complex v)

Create a new Python complex number object from a C :c:type:`Py_complex` value.

.. c:function:: PyObject* PyComplex_FromDoubles(double real, double imag)

Return a new :c:type:`PyComplexObject` object from *real* and *imag*.

.. c:function:: double PyComplex_RealAsDouble(PyObject *op)

Return the real part of *op* as a C :c:type:`double`.

.. c:function:: double PyComplex_ImagAsDouble(PyObject *op)

Return the imaginary part of *op* as a C :c:type:`double`.

.. c:function:: Py_complex PyComplex_AsCComplex(PyObject *op)

Return the :c:type:`Py_complex` value of the complex number *op*.
   Upon failure, this method returns ``-1.0`` as a real value.

.. versionchanged:: 2.6
      If *op* is not a Python complex number object but has a :meth:`__complex__`
      method, this method will first be called to convert *op* to a Python complex
      number object.

${this.title}

Code Editor : complex.rst.txt