Update docstrings for PauliSum.#5596
Merged
CirqBot merged 5 commits intoquantumlib:masterfrom Jul 7, 2022
Merged
Conversation
tanujkhattar
requested changes
Jun 23, 2022
|
|
||
| def with_qubits(self, *new_qubits: 'cirq.Qid') -> 'PauliSum': | ||
| """Return a new PauliSum on `new_qubits`. | ||
|
|
Collaborator
There was a problem hiding this comment.
I think we can use some example here / highlight that self.qubits will give a sorted list of all qubits used in the pauli sum; and new qubits will be mapped 1:1 with the sorted qubits.
The fact that pauli sum will always return a sorted list of qubits is tricky and could be helpful to provide some examples.
Collaborator
Author
There was a problem hiding this comment.
Were you thinking maybe a code snippet ?
tanujkhattar
approved these changes
Jun 29, 2022
|
|
||
|
|
||
| >>> a, b = cirq.GridQubit.rect(1, 2) | ||
| >>> sum = cirq.PauliSum() |
Collaborator
There was a problem hiding this comment.
nit: Can we show an example which constructs a non-empty pauli sum? Maybe using the .from_pauli_strings method, since that's the recommended way?
| >>> a, b = cirq.GridQubit.rect(1, 2) | ||
| >>> psum = cirq.X(a) * cirq.X(b) + 3.0 * cirq.Y(a) | ||
| >>> two_psum = 2 * psum | ||
| >>> four_psum = two_psum + two_psum |
Collaborator
There was a problem hiding this comment.
Add a print(four_sum) statement before computing the expectation, for clarity.
Comment on lines
+577
to
+579
| qubits: Iterable of qubits, ordering to determine the computational | ||
| basis of qubits. If none is provided the default ordering of | ||
| `self.qubits` is used. |
Collaborator
There was a problem hiding this comment.
Suggested change
| qubits: Iterable of qubits, ordering to determine the computational | |
| basis of qubits. If none is provided the default ordering of | |
| `self.qubits` is used. | |
| qubits: Ordered collection of qubits that determine the subspace | |
| in which the matrix representation of the Pauli sum is to | |
| be computed. If none is provided the default ordering of | |
| `self.qubits` is used. Qubits present in `qubits` but absent from | |
| `self.qubits` are acted on by the identity. |
MichaelBroughton
added
the
automerge
CirqBot
added
the
front_of_queue_automerge
rht
pushed a commit
to rht/Cirq
that referenced
this pull request
May 1, 2023
harry-phasecraft
pushed a commit
to PhaseCraft/Cirq
that referenced
this pull request
Oct 31, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.