FM / c-api

/usr/share/doc/python2-docs/html/_sources/c-api/

/usr/share/doc/python2-docs/html/_sources/c-api

Name	Size	Mode	Actions
abstract.rst.txt	702	0644	edit dl rm
allocation.rst.txt	4796	0644	edit dl rm
arg.rst.txt	26004	0644	edit dl rm
bool.rst.txt	1304	0644	edit dl rm
buffer.rst.txt	22965	0644	edit dl rm
bytearray.rst.txt	2181	0644	edit dl rm
capsule.rst.txt	5741	0644	edit dl rm
cell.rst.txt	1940	0644	edit dl rm
class.rst.txt	1866	0644	edit dl rm
cobject.rst.txt	1870	0644	edit dl rm
code.rst.txt	1635	0644	edit dl rm
codec.rst.txt	4643	0644	edit dl rm
complex.rst.txt	4079	0644	edit dl rm
concrete.rst.txt	1963	0644	edit dl rm
conversion.rst.txt	7092	0644	edit dl rm
datetime.rst.txt	6413	0644	edit dl rm
descriptor.rst.txt	1296	0644	edit dl rm
dict.rst.txt	7757	0644	edit dl rm
exceptions.rst.txt	35304	0644	edit dl rm
file.rst.txt	6198	0644	edit dl rm
float.rst.txt	3371	0644	edit dl rm
function.rst.txt	2421	0644	edit dl rm
gcsupport.rst.txt	6587	0644	edit dl rm
gen.rst.txt	920	0644	edit dl rm
import.rst.txt	11221	0644	edit dl rm
index.rst.txt	578	0644	edit dl rm
init.rst.txt	49160	0644	edit dl rm
int.rst.txt	4578	0644	edit dl rm
intro.rst.txt	28473	0644	edit dl rm
iter.rst.txt	1390	0644	edit dl rm
iterator.rst.txt	1796	0644	edit dl rm
list.rst.txt	6362	0644	edit dl rm
long.rst.txt	7987	0644	edit dl rm
mapping.rst.txt	2874	0644	edit dl rm
marshal.rst.txt	3985	0644	edit dl rm
memory.rst.txt	11556	0644	edit dl rm
method.rst.txt	2099	0644	edit dl rm
module.rst.txt	3867	0644	edit dl rm
none.rst.txt	697	0644	edit dl rm
number.rst.txt	11939	0644	edit dl rm
objbuffer.rst.txt	2516	0644	edit dl rm
object.rst.txt	17491	0644	edit dl rm
objimpl.rst.txt	305	0644	edit dl rm
refcounting.rst.txt	2934	0644	edit dl rm
reflection.rst.txt	1567	0644	edit dl rm
sequence.rst.txt	8716	0644	edit dl rm
set.rst.txt	6588	0644	edit dl rm
slice.rst.txt	2979	0644	edit dl rm
string.rst.txt	15422	0644	edit dl rm
structures.rst.txt	14966	0644	edit dl rm
sys.rst.txt	5714	0644	edit dl rm
tuple.rst.txt	5491	0644	edit dl rm
type.rst.txt	2761	0644	edit dl rm
typeobj.rst.txt	66936	0644	edit dl rm
unicode.rst.txt	45126	0644	edit dl rm
utilities.rst.txt	415	0644	edit dl rm
veryhigh.rst.txt	13363	0644	edit dl rm
weakref.rst.txt	2820	0644	edit dl rm

Edit: /usr/share/doc/python2-docs/html/_sources/c-api/complex.rst.txt (4079B)

.. 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.

cmd: