/usr/share/doc/python3-docs/html/_sources/c-api
NameSizeModeActions
abstract.rst.txt7150644editdlrm
allocation.rst.txt26530644editdlrm
apiabiversion.rst.txt22420644editdlrm
arg.rst.txt306510644editdlrm
bool.rst.txt12000644editdlrm
buffer.rst.txt222670644editdlrm
bytearray.rst.txt22500644editdlrm
bytes.rst.txt92110644editdlrm
capsule.rst.txt57410644editdlrm
cell.rst.txt19400644editdlrm
code.rst.txt16660644editdlrm
codec.rst.txt47990644editdlrm
complex.rst.txt39460644editdlrm
concrete.rst.txt20460644editdlrm
conversion.rst.txt55160644editdlrm
coro.rst.txt8200644editdlrm
datetime.rst.txt64150644editdlrm
descriptor.rst.txt11110644editdlrm
dict.rst.txt79520644editdlrm
exceptions.rst.txt478140644editdlrm
file.rst.txt32480644editdlrm
float.rst.txt22430644editdlrm
function.rst.txt33480644editdlrm
gcsupport.rst.txt60570644editdlrm
gen.rst.txt13010644editdlrm
import.rst.txt128250644editdlrm
index.rst.txt6130644editdlrm
init.rst.txt523830644editdlrm
intro.rst.txt287510644editdlrm
iter.rst.txt11290644editdlrm
iterator.rst.txt16400644editdlrm
list.rst.txt47350644editdlrm
long.rst.txt104360644editdlrm
mapping.rst.txt28710644editdlrm
marshal.rst.txt35610644editdlrm
memory.rst.txt213690644editdlrm
memoryview.rst.txt23480644editdlrm
method.rst.txt28180644editdlrm
module.rst.txt182660644editdlrm
none.rst.txt7400644editdlrm
number.rst.txt105830644editdlrm
objbuffer.rst.txt21980644editdlrm
object.rst.txt174200644editdlrm
objimpl.rst.txt3040644editdlrm
refcounting.rst.txt29090644editdlrm
reflection.rst.txt14170644editdlrm
sequence.rst.txt65470644editdlrm
set.rst.txt61440644editdlrm
slice.rst.txt24040644editdlrm
stable.rst.txt19690644editdlrm
structures.rst.txt137870644editdlrm
sys.rst.txt99440644editdlrm
tuple.rst.txt80310644editdlrm
type.rst.txt39630644editdlrm
typeobj.rst.txt601840644editdlrm
unicode.rst.txt680740644editdlrm
utilities.rst.txt4140644editdlrm
veryhigh.rst.txt166550644editdlrm
weakref.rst.txt26350644editdlrm
Edit: /usr/share/doc/python3-docs/html/_sources/c-api/complex.rst.txt (3946B)
.. 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 :class:`complex` in the Python layer. .. c:function:: int PyComplex_Check(PyObject *p) Return true if its argument is a :c:type:`PyComplexObject` or a subtype of :c:type:`PyComplexObject`. .. 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`. .. 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*. 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. Upon failure, this method returns ``-1.0`` as a real value.