Complex Number Objects¶

typePyComplexObject¶

This subtype ofPyObject represents a Python complex number object.

Py_complexcval¶

The complex number value, using the CPy_complex representation.

Deprecated since version 3.15, will be removed in version 3.20:UsePyComplex_AsCComplex() andPyComplex_FromCComplex() to convert aPython complex number to/from the CPy_complexrepresentation.

PyTypeObjectPyComplex_Type¶

Part of theStable ABI.

This instance ofPyTypeObject represents the Python complex numbertype. It is the same object ascomplex in the Python layer.

intPyComplex_Check(PyObject*p)¶

Return true if its argument is aPyComplexObject or a subtype ofPyComplexObject. This function always succeeds.

intPyComplex_CheckExact(PyObject*p)¶

Return true if its argument is aPyComplexObject, but not a subtype ofPyComplexObject. This function always succeeds.

PyObject*PyComplex_FromDoubles(doublereal,doubleimag)¶

Return value: New reference. Part of theStable ABI.

Return a newPyComplexObject object fromreal andimag.ReturnNULL with an exception set on error.

doublePyComplex_RealAsDouble(PyObject*op)¶

Part of theStable ABI.

Return the real part ofop as a Cdouble.

Ifop is not a Python complex number object but has a__complex__() method, this method will first be called toconvertop to a Python complex number object. If__complex__() isnot defined then it falls back to callPyFloat_AsDouble() andreturns its result.

Upon failure, this method returns-1.0 with an exception set, so oneshould callPyErr_Occurred() to check for errors.

Changed in version 3.13:Use__complex__() if available.

doublePyComplex_ImagAsDouble(PyObject*op)¶

Part of theStable ABI.

Return the imaginary part ofop as a Cdouble.

Ifop is not a Python complex number object but has a__complex__() method, this method will first be called toconvertop to a Python complex number object. If__complex__() isnot defined then it falls back to callPyFloat_AsDouble() andreturns0.0 on success.

Upon failure, this method returns-1.0 with an exception set, so oneshould callPyErr_Occurred() to check for errors.

Changed in version 3.13:Use__complex__() if available.

typePy_complex¶

This C structure defines an export format for a Python complexnumber object.

doublereal¶

doubleimag¶

The structure is defined as:

typedefstruct{doublereal;doubleimag;}Py_complex;

PyObject*PyComplex_FromCComplex(Py_complexv)¶

Return value: New reference.

Create a new Python complex number object from a CPy_complex value.ReturnNULL with an exception set on error.

Py_complexPyComplex_AsCComplex(PyObject*op)¶

Return thePy_complex value of the complex numberop.

Ifop is not a Python complex number object but has a__complex__()method, this method will first be called to convertop to a Python complexnumber object. If__complex__() is not defined then it falls back to__float__(). If__float__() is not defined then it falls backto__index__().

Upon failure, this method returnsPy_complexwithreal set to-1.0 and with an exception set, so oneshould callPyErr_Occurred() to check for errors.

Changed in version 3.8:Use__index__() if available.