Skip to content
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.

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

Fixed Incoherent notation for the RZX Gate api doc #12754

Merged
merged 3 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions qiskit/circuit/library/standard_gates/rzx.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,19 +97,19 @@ class RZXGate(Gate):

.. math::

R_{ZX}(\theta = 0) = I
R_{ZX}(\theta = 0)\ q_0, q_1 = I

.. math::

R_{ZX}(\theta = 2\pi) = -I
R_{ZX}(\theta = 2\pi)\ q_0, q_1 = -I

.. math::

R_{ZX}(\theta = \pi) = -i Z \otimes X
R_{ZX}(\theta = \pi)\ q_0, q_1 = -i X \otimes Z

.. math::

RZX(\theta = \frac{\pi}{2}) = \frac{1}{\sqrt{2}}
R_{ZX}(\theta = \frac{\pi}{2})\ q_0, q_1 = \frac{1}{\sqrt{2}}
\begin{pmatrix}
1 & 0 & -i & 0 \\
0 & 1 & 0 & i \\
Expand Down
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't typically write release notes for doc fixes, you can just delete this file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do. Thanks for the review @Cryoris

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
fixes:
- |
Fixed the api documentation for :class:`.RZXGate` which was incoherent with its notation.
The default notation for RZX gate was in big-endian and the example shown was in little-endian format.
Fix is done in the example section where the gate notation is concatenated with q_0 , q_1 and
big-endian format is followed throughout.
For example intial notation was :
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example intial notation was :
For example initial notation was :

R_{ZX}(\theta = 0) = I

Now it would be
R_{ZX}(\theta = 0)\ q_0, q_1 = I