FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[3.12] gh-121834: Improve `complex` C-API docs (GH-121835) by sobolevn · Pull Request #121897 · python/cpython · GitHub

/ cpython Public

[3.12] gh-121834: Improve complex C-API docs (GH-121835) #121897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sobolevn merged 3 commits into from
Jul 17, 2024
Conversation 3 Commits 3 Checks 0 Files changed
Merged

[3.12] gh-121834: Improve complex C-API docs (GH-121835) #121897

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e11ca8e
[3.12] gh-121834: Improve `complex` C-API docs (GH-121835)
sobolevn Jul 17, 2024
d2de788
Update complex.rst
sobolevn Jul 17, 2024
f064027
Update Doc/c-api/complex.rst
sobolevn Jul 17, 2024
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
24 changes: 18 additions & 6 deletions Doc/c-api/complex.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,16 @@ pointers. This is consistent throughout the API.

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::
use structures of this type as input or output values, as appropriate.

.. c:member:: double real
double imag

The structure is defined as::

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


Expand Down Expand Up @@ -106,17 +110,22 @@ Complex Numbers as Python Objects
.. c:function:: PyObject* PyComplex_FromCComplex(Py_complex v)

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


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

Return a new :c:type:`PyComplexObject` object from *real* and *imag*.
Return ``NULL`` with an exception set on error.


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

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

Upon failure, this method returns ``-1.0`` with an exception set, so one
should call :c:func:`PyErr_Occurred` to check for errors.


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

Expand All @@ -131,8 +140,11 @@ Complex Numbers as Python Objects
method, this method will first be called to convert *op* to a Python complex
number object. If :meth:`!__complex__` is not defined then it falls back to
:meth:`~object.__float__`. If :meth:`!__float__` is not defined then it falls back
to :meth:`~object.__index__`. Upon failure, this method returns ``-1.0`` as a real
value.
to :meth:`~object.__index__`.

Upon failure, this method returns :c:type:`Py_complex`
with :c:member:`~Py_complex.real` set to ``-1.0`` and with an exception set, so one
should call :c:func:`PyErr_Occurred` to check for errors.

.. versionchanged:: 3.8
Use :meth:`~object.__index__` if available.
Back | FazBrowse Home | New Git URL