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

r1 and rz descriptions in API lack clarity of their differentiation #2160

Open
3 of 4 tasks
mmvandieren opened this issue Aug 27, 2024 · 0 comments
Open
3 of 4 tasks
Labels
documentation Improvements or additions to documentation

Comments

@mmvandieren
Copy link
Contributor

Required prerequisites

  • Consult the security policy. If reporting a security vulnerability, do not report the bug using this form. Use the process described in the policy to report the issue.
  • Make sure you've read the documentation. Your issue may be addressed there.
  • Search the issue tracker to verify that this hasn't already been reported. +1 or comment there if it has.
  • If possible, make a PR with a failing test to give us a starting point to work on!

Describe the bug

the r1 and rz have descriptions in the API as rotations about the |1> state and the z-axis, respectively. These are identical rotations, yet the gates are not identical. A sentence mentioning how the phase differs would be useful.

I'll submit a PR with a suggestion for clarity.

Steps to reproduce the bug

compare the descriptions of r1 and rz
https://nvidia.github.io/cuda-quantum/latest/api/default_ops.html

Expected behavior

Reader should recognize the different behavior of the 2 gates through the verbal descriptions (without having to dive into the matrix multiplication)

Is this a regression? If it is, put the last known working version (or commit) here.

Not a regression

Environment

  • CUDA Quantum version:
  • Python version:
  • C++ compiler:
  • Operating system:

Suggestions

No response

@schweitzpgi schweitzpgi added the documentation Improvements or additions to documentation label Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants