Update docstrings for PauliSum. #5596
Conversation
| @@ -459,6 +476,21 @@ def qubits(self) -> Tuple[raw_types.Qid, ...]: | |||
| return tuple(sorted(qs)) | |||
|
|
|||
| def with_qubits(self, *new_qubits: 'cirq.Qid') -> 'PauliSum': | |||
| """Return a new PauliSum on `new_qubits`. | |||
|
|
|||
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.
There was a problem hiding this comment.
Were you thinking maybe a code snippet ?
|
|
||
|
|
||
| >>> a, b = cirq.GridQubit.rect(1, 2) | ||
| >>> sum = cirq.PauliSum() |
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 |
There was a problem hiding this comment.
Add a print(four_sum) statement before computing the expectation, for clarity.
| qubits: Iterable of qubits, ordering to determine the computational | ||
| basis of qubits. If none is provided the default ordering of | ||
| `self.qubits` is used. |
There was a problem hiding this comment.
| 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
No description provided.