summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorSergey B Kirpichev <skirpichev@gmail.com>2024-11-26 15:57:39 (GMT)
committerGitHub <noreply@github.com>2024-11-26 15:57:39 (GMT)
commit987311d42e3ec838de8ff27f9f0575aa791a6bde (patch)
treed05e0da42e5cdf50d774368dfede7f93ef2ee2bd /Doc
parentdcf629213bc046318c862ec0af5db3dfd1fc473a (diff)
downloadcpython-987311d42e3ec838de8ff27f9f0575aa791a6bde.zip
cpython-987311d42e3ec838de8ff27f9f0575aa791a6bde.tar.gz
cpython-987311d42e3ec838de8ff27f9f0575aa791a6bde.tar.bz2
gh-69639: Add mixed-mode rules for complex arithmetic (C-like) (GH-124829)
"Generally, mixed-mode arithmetic combining real and complex variables should be performed directly, not by first coercing the real to complex, lest the sign of zero be rendered uninformative; the same goes for combinations of pure imaginary quantities with complex variables." (c) Kahan, W: Branch cuts for complex elementary functions. This patch implements mixed-mode arithmetic rules, combining real and complex variables as specified by C standards since C99 (in particular, there is no special version for the true division with real lhs operand). Most C compilers implementing C99+ Annex G have only these special rules (without support for imaginary type, which is going to be deprecated in C2y).
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/complex.rst54
-rw-r--r--Doc/library/cmath.rst12
-rw-r--r--Doc/library/stdtypes.rst16
-rw-r--r--Doc/reference/expressions.rst25
-rw-r--r--Doc/whatsnew/3.14.rst4
5 files changed, 93 insertions, 18 deletions
diff --git a/Doc/c-api/complex.rst b/Doc/c-api/complex.rst
index 16bd794..d1f5d8e 100644
--- a/Doc/c-api/complex.rst
+++ b/Doc/c-api/complex.rst
@@ -44,12 +44,36 @@ pointers. This is consistent throughout the API.
representation.
+.. c:function:: Py_complex _Py_cr_sum(Py_complex left, double right)
+
+ Return the sum of a complex number and a real number, using the C :c:type:`Py_complex`
+ representation.
+
+ .. versionadded:: 3.14
+
+
.. 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_cr_diff(Py_complex left, double right)
+
+ Return the difference between a complex number and a real number, using the C
+ :c:type:`Py_complex` representation.
+
+ .. versionadded:: 3.14
+
+
+.. c:function:: Py_complex _Py_rc_diff(double left, Py_complex right)
+
+ Return the difference between a real number and a complex number, using the C
+ :c:type:`Py_complex` representation.
+
+ .. versionadded:: 3.14
+
+
.. c:function:: Py_complex _Py_c_neg(Py_complex num)
Return the negation of the complex number *num*, using the C
@@ -62,6 +86,14 @@ pointers. This is consistent throughout the API.
representation.
+.. c:function:: Py_complex _Py_cr_prod(Py_complex left, double right)
+
+ Return the product of a complex number and a real number, using the C
+ :c:type:`Py_complex` representation.
+
+ .. versionadded:: 3.14
+
+
.. 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`
@@ -71,6 +103,28 @@ pointers. This is consistent throughout the API.
:c:data:`errno` to :c:macro:`!EDOM`.
+.. c:function:: Py_complex _Py_cr_quot(Py_complex dividend, double divisor)
+
+ Return the quotient of a complex number and a real number, using the C
+ :c:type:`Py_complex` representation.
+
+ If *divisor* is zero, this method returns zero and sets
+ :c:data:`errno` to :c:macro:`!EDOM`.
+
+ .. versionadded:: 3.14
+
+
+.. c:function:: Py_complex _Py_rc_quot(double dividend, Py_complex divisor)
+
+ Return the quotient of a real number and a complex number, using the C
+ :c:type:`Py_complex` representation.
+
+ If *divisor* is zero, this method returns zero and sets
+ :c:data:`errno` to :c:macro:`!EDOM`.
+
+ .. versionadded:: 3.14
+
+
.. 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`
diff --git a/Doc/library/cmath.rst b/Doc/library/cmath.rst
index f122e36..e7c027d 100644
--- a/Doc/library/cmath.rst
+++ b/Doc/library/cmath.rst
@@ -24,17 +24,17 @@ the function is then applied to the result of the conversion.
imaginary axis we look at the sign of the real part.
For example, the :func:`cmath.sqrt` function has a branch cut along the
- negative real axis. An argument of ``complex(-2.0, -0.0)`` is treated as
+ negative real axis. An argument of ``-2-0j`` is treated as
though it lies *below* the branch cut, and so gives a result on the negative
imaginary axis::
- >>> cmath.sqrt(complex(-2.0, -0.0))
+ >>> cmath.sqrt(-2-0j)
-1.4142135623730951j
- But an argument of ``complex(-2.0, 0.0)`` is treated as though it lies above
+ But an argument of ``-2+0j`` is treated as though it lies above
the branch cut::
- >>> cmath.sqrt(complex(-2.0, 0.0))
+ >>> cmath.sqrt(-2+0j)
1.4142135623730951j
@@ -63,9 +63,9 @@ rectangular coordinates to polar coordinates and back.
along the negative real axis. The sign of the result is the same as the
sign of ``x.imag``, even when ``x.imag`` is zero::
- >>> phase(complex(-1.0, 0.0))
+ >>> phase(-1+0j)
3.141592653589793
- >>> phase(complex(-1.0, -0.0))
+ >>> phase(-1-0j)
-3.141592653589793
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 2347437..4f4fc9f 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -243,6 +243,9 @@ numeric literal yields an imaginary number (a complex number with a zero real
part) which you can add to an integer or float to get a complex number with real
and imaginary parts.
+The constructors :func:`int`, :func:`float`, and
+:func:`complex` can be used to produce numbers of a specific type.
+
.. index::
single: arithmetic
pair: built-in function; int
@@ -262,12 +265,15 @@ and imaginary parts.
Python fully supports mixed arithmetic: when a binary arithmetic operator has
operands of different numeric types, the operand with the "narrower" type is
-widened to that of the other, where integer is narrower than floating point,
-which is narrower than complex. A comparison between numbers of different types
-behaves as though the exact values of those numbers were being compared. [2]_
+widened to that of the other, where integer is narrower than floating point.
+Arithmetic with complex and real operands is defined by the usual mathematical
+formula, for example::
-The constructors :func:`int`, :func:`float`, and
-:func:`complex` can be used to produce numbers of a specific type.
+ x + complex(u, v) = complex(x + u, v)
+ x * complex(u, v) = complex(x * u, x * v)
+
+A comparison between numbers of different types behaves as though the exact
+values of those numbers were being compared. [2]_
All numeric types (except complex) support the following operations (for priorities of
the operations, see :ref:`operator-summary`):
diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst
index 3eaceae..7c95b20 100644
--- a/Doc/reference/expressions.rst
+++ b/Doc/reference/expressions.rst
@@ -28,13 +28,12 @@ Arithmetic conversions
.. index:: pair: arithmetic; conversion
When a description of an arithmetic operator below uses the phrase "the numeric
-arguments are converted to a common type", this means that the operator
+arguments are converted to a common real type", this means that the operator
implementation for built-in types works as follows:
-* If either argument is a complex number, the other is converted to complex;
+* If both arguments are complex numbers, no conversion is performed;
-* otherwise, if either argument is a floating-point number, the other is
- converted to floating point;
+* if either argument is a complex or a floating-point number, the other is converted to a floating-point number;
* otherwise, both must be integers and no conversion is necessary.
@@ -1323,12 +1322,16 @@ operators and one for additive operators:
The ``*`` (multiplication) operator yields the product of its arguments. The
arguments must either both be numbers, or one argument must be an integer and
the other must be a sequence. In the former case, the numbers are converted to a
-common type and then multiplied together. In the latter case, sequence
+common real type and then multiplied together. In the latter case, sequence
repetition is performed; a negative repetition factor yields an empty sequence.
This operation can be customized using the special :meth:`~object.__mul__` and
:meth:`~object.__rmul__` methods.
+.. versionchanged:: 3.14
+ If only one operand is a complex number, the other operand is converted
+ to a floating-point number.
+
.. index::
single: matrix multiplication
pair: operator; @ (at)
@@ -1396,23 +1399,31 @@ floating-point number using the :func:`abs` function if appropriate.
The ``+`` (addition) operator yields the sum of its arguments. The arguments
must either both be numbers or both be sequences of the same type. In the
-former case, the numbers are converted to a common type and then added together.
+former case, the numbers are converted to a common real type and then added together.
In the latter case, the sequences are concatenated.
This operation can be customized using the special :meth:`~object.__add__` and
:meth:`~object.__radd__` methods.
+.. versionchanged:: 3.14
+ If only one operand is a complex number, the other operand is converted
+ to a floating-point number.
+
.. index::
single: subtraction
single: operator; - (minus)
single: - (minus); binary operator
The ``-`` (subtraction) operator yields the difference of its arguments. The
-numeric arguments are first converted to a common type.
+numeric arguments are first converted to a common real type.
This operation can be customized using the special :meth:`~object.__sub__` and
:meth:`~object.__rsub__` methods.
+.. versionchanged:: 3.14
+ If only one operand is a complex number, the other operand is converted
+ to a floating-point number.
+
.. _shifting:
diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst
index 0e4b9eb..869a47c 100644
--- a/Doc/whatsnew/3.14.rst
+++ b/Doc/whatsnew/3.14.rst
@@ -230,6 +230,10 @@ Other language changes
They raise an error if the argument is a string.
(Contributed by Serhiy Storchaka in :gh:`84978`.)
+* Implement mixed-mode arithmetic rules combining real and complex numbers as
+ specified by C standards since C99.
+ (Contributed by Sergey B Kirpichev in :gh:`69639`.)
+
* All Windows code pages are now supported as "cpXXX" codecs on Windows.
(Contributed by Serhiy Storchaka in :gh:`123803`.)