doc: define complex scalar <op> fp array #871
Open
Conversation
This file contains 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
kgryte
added
API change
lucascolley
reviewed
Dec 23, 2024
Comment on lines
+149
to
+152
| .. note:: | ||
| Mixing a Python ``complex`` and an array with a real-valued data type is allowed; the result is an array of the data type of the same *precision* as the array operand. In other word, ``1j <op> float32_array`` results in a ``complex64`` array; ``1j <op> float64_array`` results in a ``complex128`` array. | ||
|
|
||
| Behavior is not specificed when mixing ``complex`` scalars with integer arrays; this may give ``complex64``, ``complex128``, or raise an exception. Behavior is implementation-specific. |
There was a problem hiding this comment.
would we want to add a versionchanged directive for this?
There was a problem hiding this comment.
Typically, I add all version changed directives at the same time after compiling the changelog, not on a PR-by-PR basis. While it is thus far common for us to release a December version, this isn't guaranteed, so I have typically avoided adding such annotations until the spec release has been finalized.
lucascolley
approved these changes
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Address gh-841, which continued from #478. If I read the discussion right, there is a general support for allowing binary operations between a python
complexscalar and a floating-point array.The proposed wording tries to be explicit about preserving the precision:
(1j*single_precision_array).dtype == single_precision_complexand(1j*double_precision_array).dtype == double_precision_complex. As long as we don't have to worry about half- or extended precision, being explicit feels simplest.