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.

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

Jump to bottom

Document the Plethora of PauliStrings. #5352

Closed
dabacon opened this issue May 11, 2022 · 1 comment · Fixed by #5624
Closed

Document the Plethora of PauliStrings. #5352

dabacon opened this issue May 11, 2022 · 1 comment · Fixed by #5624
Assignees
@tanujkhattar @augustehirth
Labels
area/docstrings kind/docs Documentation related problems, ideas, requests triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on

Comments

@dabacon
Copy link
Collaborator

dabacon commented May 11, 2022

We have PauliString, MutablePauliString, DensePauliString, and MutableDensePauliString, but no discussion of what the difference is between these and when one should use each of these. The dense ones, to my understanding, have no qubits associated with them, while the non-dense ones have gates associated with them (and so is :( an Operation). In #5344 I added some documentation to the gate ones, but the documentation for the sparse ones needs to be updated. Likely they should refer to each other to help clarify.
@dabacon dabacon added kind/bug-report Something doesn't seem to work. kind/docs Documentation related problems, ideas, requests and removed kind/bug-report Something doesn't seem to work. labels May 11, 2022
@viathor viathor added triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on area/docstrings labels May 20, 2022
@dstrain115
Copy link
Collaborator

@augustehirth We think we should add documentation on pauli strings. Where does this fit into the doc re-org for 1.0? Once this is decided, please re-assign back to one of the developers, possibly @tanujkhattar

This was referenced Jun 25, 2022
Merged
Merged
CirqBot pushed a commit that referenced this issue Jun 27, 2022
@tanujkhattar
PauliString and MutablePauliString docs and inconsistencies fixes (…
d7dcd25 
…#5621)

Fixes #5572
Part of #5352
rht pushed a commit to rht/Cirq that referenced this issue May 1, 2023
@tanujkhattar @rht
PauliString and MutablePauliString docs and inconsistencies fixes (…
56f66d7 
…quantumlib#5621)

Fixes quantumlib#5572
Part of quantumlib#5352
harry-phasecraft pushed a commit to PhaseCraft/Cirq that referenced this issue Oct 31, 2024
@tanujkhattar
PauliString and MutablePauliString docs and inconsistencies fixes (…
f68b69e 
…quantumlib#5621)

Fixes quantumlib#5572
Part of quantumlib#5352
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tanujkhattar tanujkhattar

@augustehirth augustehirth

Labels
area/docstrings kind/docs Documentation related problems, ideas, requests triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DensePauliString and MutableDensePauliString docs and inconsistencies fixes quantumlib/Cirq
5 participants
@dabacon @tanujkhattar @dstrain115 @viathor @augustehirth