Objets représentant des nombres complexes
*****************************************

Les nombres complexes Python sont implémentés comme deux types
distincts, lorsqu'ils sont vus de l'API C : l'un est l'objet Python
tel qu'il est vu par les programmes Python, et l'autre est une
structure C qui représente la valeur exacte du nombre complexe. L'API
fournit des fonctions pour travailler avec ces deux représentations.


Nombres complexes en tant que structures C
==========================================

Les fonctions qui acceptent ces structures comme paramètres et les
renvoient comme résultats le font en fonction de leur *valeur* au lieu
de les dé-référencer en utilisant des pointeurs. C'est constant dans
toute l'API.

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.

   double real
   double imag

   The structure is defined as:

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

Py_complex _Py_c_sum(Py_complex left, Py_complex right)

   Renvoie la somme de deux nombres complexes, sous la forme d'un
   "Py_complex" en C.

Py_complex _Py_c_diff(Py_complex left, Py_complex right)

   Renvoie la différence de deux nombres complexes, sous la forme d'un
   "Py_complex" en C.

Py_complex _Py_c_neg(Py_complex num)

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

Py_complex _Py_c_prod(Py_complex left, Py_complex right)

   Renvoie le produit de deux nombres complexes, sous la forme d'un
   "Py_complex" en C.

Py_complex _Py_c_quot(Py_complex dividend, Py_complex divisor)

   Renvoie le quotient de deux nombres complexes, sous la forme d'un
   "Py_complex" en C.

   If *divisor* is null, this method returns zero and sets "errno" to
   "EDOM".

Py_complex _Py_c_pow(Py_complex num, Py_complex exp)

   Renvoie *num* à la puissance *exp*, sous la forme d'un "Py_complex"
   en C.

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

   Set "errno" to "ERANGE" on overflows.


Nombres complexes en tant qu'objets Python
==========================================

type PyComplexObject

   Ce sous-type de l'objet "PyObject" représente un nombre complexe en
   Python.

PyTypeObject PyComplex_Type
    * Fait partie de l' ABI stable.*

   Cette instance de "PyTypeObject" représente le type nombre complexe
   Python. C'est le même objet que la classe "complex" de la couche
   Python.

int PyComplex_Check(PyObject *p)

   Return true if its argument is a "PyComplexObject" or a subtype of
   "PyComplexObject".  This function always succeeds.

int PyComplex_CheckExact(PyObject *p)

   Return true if its argument is a "PyComplexObject", but not a
   subtype of "PyComplexObject".  This function always succeeds.

PyObject *PyComplex_FromCComplex(Py_complex v)
    *Valeur de retour : nouvelle référence.*

   Create a new Python complex number object from a C "Py_complex"
   value. Return "NULL" with an exception set on error.

PyObject *PyComplex_FromDoubles(double real, double imag)
    *Valeur de retour : nouvelle référence.** Fait partie de l' ABI
   stable.*

   Return a new "PyComplexObject" object from *real* and *imag*.
   Return "NULL" with an exception set on error.

double PyComplex_RealAsDouble(PyObject *op)
    * Fait partie de l' ABI stable.*

   Return the real part of *op* as a C double.

   If *op* is not a Python complex number object but has a
   "__complex__()" method, this method will first be called to convert
   *op* to a Python complex number object.  If "__complex__()" is not
   defined then it falls back to call "PyFloat_AsDouble()" and returns
   its result.

   Upon failure, this method returns "-1.0" with an exception set, so
   one should call "PyErr_Occurred()" to check for errors.

   Modifié dans la version 3.13: Use "__complex__()" if available.

double PyComplex_ImagAsDouble(PyObject *op)
    * Fait partie de l' ABI stable.*

   Return the imaginary part of *op* as a C double.

   If *op* is not a Python complex number object but has a
   "__complex__()" method, this method will first be called to convert
   *op* to a Python complex number object.  If "__complex__()" is not
   defined then it falls back to call "PyFloat_AsDouble()" and returns
   "0.0" on success.

   Upon failure, this method returns "-1.0" with an exception set, so
   one should call "PyErr_Occurred()" to check for errors.

   Modifié dans la version 3.13: Use "__complex__()" if available.

Py_complex PyComplex_AsCComplex(PyObject *op)

   Renvoie la valeur du nombre complexe *op* sous la forme d'un
   "Py_complex" en C.

   If *op* is not a Python complex number object but has a
   "__complex__()" method, this method will first be called to convert
   *op* to a Python complex number object.  If "__complex__()" is not
   defined then it falls back to "__float__()".  If "__float__()" is
   not defined then it falls back to "__index__()".

   Upon failure, this method returns "Py_complex" with "real" set to
   "-1.0" and with an exception set, so one should call
   "PyErr_Occurred()" to check for errors.

   Modifié dans la version 3.8: Use "__index__()" if available.
