scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qiskit-documentation/docs/api/qiskit/qiskit.quantum_info.PauliLi...

824 lines
33 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: PauliList
description: API reference for qiskit.quantum_info.PauliList
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.quantum_info.PauliList
---
# PauliList
<Class id="qiskit.quantum_info.PauliList" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L33-L1231" signature="qiskit.quantum_info.PauliList(data)" modifiers="class">
Bases: `BasePauli`, `LinearMixin`, `GroupMixin`
List of N-qubit Pauli operators.
This class is an efficient representation of a list of [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") operators. It supports 1D numpy array indexing returning a [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") for integer indexes or a [`PauliList`](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") for slice or list indices.
**Initialization**
A PauliList object can be initialized in several ways.
> **`PauliList(list[str])`**
>
> where strings are same representation with [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli").
>
> **`PauliList(Pauli) and PauliList(list[Pauli])`**
>
> where Pauli is [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli").
>
> **`PauliList.from_symplectic(z, x, phase)`**
>
> where `z` and `x` are 2 dimensional boolean `numpy.ndarrays` and `phase` is an integer in `[0, 1, 2, 3]`.
For example,
```python
import numpy as np
from qiskit.quantum_info import Pauli, PauliList
# 1. init from list[str]
pauli_list = PauliList(["II", "+ZI", "-iYY"])
print("1. ", pauli_list)
pauli1 = Pauli("iXI")
pauli2 = Pauli("iZZ")
# 2. init from Pauli
print("2. ", PauliList(pauli1))
# 3. init from list[Pauli]
print("3. ", PauliList([pauli1, pauli2]))
# 4. init from np.ndarray
z = np.array([[True, True], [False, False]])
x = np.array([[False, True], [True, False]])
phase = np.array([0, 1])
pauli_list = PauliList.from_symplectic(z, x, phase)
print("4. ", pauli_list)
```
```python
1. ['II', 'ZI', '-iYY']
2. ['iXI']
3. ['iXI', 'iZZ']
4. ['YZ', '-iIX']
```
**Data Access**
The individual Paulis can be accessed and updated using the `[]` operator which accepts integer, lists, or slices for selecting subsets of PauliList. If integer is given, it returns Pauli not PauliList.
```python
pauli_list = PauliList(["XX", "ZZ", "IZ"])
print("Integer: ", repr(pauli_list[1]))
print("List: ", repr(pauli_list[[0, 2]]))
print("Slice: ", repr(pauli_list[0:2]))
```
```python
Integer: Pauli('ZZ')
List: PauliList(['XX', 'IZ'])
Slice: PauliList(['XX', 'ZZ'])
```
**Iteration**
Rows in the Pauli table can be iterated over like a list. Iteration can also be done using the label or matrix representation of each row using the [`label_iter()`](#qiskit.quantum_info.PauliList.label_iter "qiskit.quantum_info.PauliList.label_iter") and [`matrix_iter()`](#qiskit.quantum_info.PauliList.matrix_iter "qiskit.quantum_info.PauliList.matrix_iter") methods.
Initialize the PauliList.
**Parameters**
**data** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – input data for Paulis. If input is a list each item in the list must be a Pauli object or Pauli str.
**Raises**
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if input array is invalid shape.
**Additional Information:**
The input array is not copied so multiple Pauli tables can share the same underlying array.
## Attributes
### dim
<Attribute id="qiskit.quantum_info.PauliList.dim">
Return tuple (input\_shape, output\_shape).
</Attribute>
### num\_qubits
<Attribute id="qiskit.quantum_info.PauliList.num_qubits">
Return the number of qubits if a N-qubit operator or None otherwise.
</Attribute>
### phase
<Attribute id="qiskit.quantum_info.PauliList.phase">
Return the phase exponent of the PauliList.
</Attribute>
### qargs
<Attribute id="qiskit.quantum_info.PauliList.qargs">
Return the qargs for the operator.
</Attribute>
### settings
<Attribute id="qiskit.quantum_info.PauliList.settings">
Return settings.
</Attribute>
### shape
<Attribute id="qiskit.quantum_info.PauliList.shape">
The full shape of the `array()`
</Attribute>
### size
<Attribute id="qiskit.quantum_info.PauliList.size">
The number of Pauli rows in the table.
</Attribute>
### x
<Attribute id="qiskit.quantum_info.PauliList.x">
The x array for the symplectic representation.
</Attribute>
### z
<Attribute id="qiskit.quantum_info.PauliList.z">
The z array for the symplectic representation.
</Attribute>
## Methods
### adjoint
<Function id="qiskit.quantum_info.PauliList.adjoint" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L821-L823" signature="adjoint()">
Return the adjoint of each Pauli in the list.
</Function>
### anticommutes
<Function id="qiskit.quantum_info.PauliList.anticommutes" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L849-L859" signature="anticommutes(other, qargs=None)">
Return `True` if other Pauli that anticommutes with other.
**Parameters**
* **other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList operator.
* **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – qubits to apply dot product on (default: `None`).
**Returns**
`True` if Paulis anticommute, `False` if they commute.
**Return type**
[bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")
</Function>
### anticommutes\_with\_all
<Function id="qiskit.quantum_info.PauliList.anticommutes_with_all" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L876-L889" signature="anticommutes_with_all(other)">
Return indexes of rows that commute other.
If `other` is a multi-row Pauli list the returned vector indexes rows of the current PauliList that anti-commute with *all* Paulis in other. If no rows satisfy the condition the returned array will be empty.
**Parameters**
**other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – a single Pauli or multi-row PauliList.
**Returns**
index array of the anti-commuting rows.
**Return type**
array
</Function>
### argsort
<Function id="qiskit.quantum_info.PauliList.argsort" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L473-L534" signature="argsort(weight=False, phase=False)">
Return indices for sorting the rows of the table.
The default sort method is lexicographic sorting by qubit number. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Paulis of a given weight are still ordered lexicographically.
**Parameters**
* **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Optionally sort by weight if `True` (Default: `False`).
* **phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Optionally sort by phase before weight or order (Default: `False`).
**Returns**
the indices for sorting the table.
**Return type**
array
</Function>
### commutes
<Function id="qiskit.quantum_info.PauliList.commutes" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L833-L847" signature="commutes(other, qargs=None)">
Return True for each Pauli that commutes with other.
**Parameters**
* **other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList operator.
* **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – qubits to apply dot product on (default: `None`).
**Returns**
`True` if Paulis commute, `False` if they anti-commute.
**Return type**
[bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")
</Function>
### commutes\_with\_all
<Function id="qiskit.quantum_info.PauliList.commutes_with_all" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L861-L874" signature="commutes_with_all(other)">
Return indexes of rows that commute `other`.
If `other` is a multi-row Pauli list the returned vector indexes rows of the current PauliList that commute with *all* Paulis in other. If no rows satisfy the condition the returned array will be empty.
**Parameters**
**other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – a single Pauli or multi-row PauliList.
**Returns**
index array of the commuting rows.
**Return type**
array
</Function>
### compose
<Function id="qiskit.quantum_info.PauliList.compose" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L705-L738" signature="compose(other, qargs=None, front=False, inplace=False)">
Return the composition self∘other for each Pauli in the list.
**Parameters**
* **other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList.
* **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – qubits to apply dot product on (Default: `None`).
* **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If True use dot composition method \[default: `False`].
* **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If `True` update in-place (default: `False`).
**Returns**
the list of composed Paulis.
**Return type**
[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")
**Raises**
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if other cannot be converted to a PauliList, does not have either 1 or the same number of Paulis as the current list, or has the wrong number of qubits for the specified `qargs`.
</Function>
### conjugate
<Function id="qiskit.quantum_info.PauliList.conjugate" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L813-L815" signature="conjugate()">
Return the conjugate of each Pauli in the list.
</Function>
### copy
<Function id="qiskit.quantum_info.PauliList.copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/base_pauli.py#L61-L70" signature="copy()">
Make a deep copy of current operator.
</Function>
### delete
<Function id="qiskit.quantum_info.PauliList.delete" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L359-L404" signature="delete(ind, qubit=False)">
Return a copy with Pauli rows deleted from table.
When deleting qubits the qubit index is the same as the column index of the underlying `X` and `Z` arrays.
**Parameters**
* **ind** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – index(es) to delete.
* **qubit** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if `True` delete qubit columns, otherwise delete Pauli rows (Default: `False`).
**Returns**
the resulting table with the entries removed.
**Return type**
[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")
**Raises**
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if `ind` is out of bounds for the array size or number of qubits.
</Function>
### dot
<Function id="qiskit.quantum_info.PauliList.dot" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L740-L757" signature="dot(other, qargs=None, inplace=False)">
Return the composition other∘self for each Pauli in the list.
**Parameters**
* **other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList.
* **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – qubits to apply dot product on (Default: `None`).
* **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If True update in-place (default: `False`).
**Returns**
the list of composed Paulis.
**Return type**
[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")
**Raises**
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if other cannot be converted to a PauliList, does not have either 1 or the same number of Paulis as the current list, or has the wrong number of qubits for the specified `qargs`.
</Function>
### equiv
<Function id="qiskit.quantum_info.PauliList.equiv" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L235-L247" signature="equiv(other)">
Entrywise comparison of Pauli equivalence up to global phase.
**Parameters**
**other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") *or*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a comparison object.
**Returns**
**An array of `True` or `False` for entrywise equivalence**
of the current table.
**Return type**
np.ndarray
</Function>
### evolve
<Function id="qiskit.quantum_info.PauliList.evolve" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L915-L952" signature="evolve(other, qargs=None, frame='h')">
Performs either Heisenberg (default) or Schrödinger picture evolution of the Pauli by a Clifford and returns the evolved Pauli.
Schrödinger picture evolution can be chosen by passing parameter `frame='s'`. This option yields a faster calculation.
Heisenberg picture evolves the Pauli as $P^\prime = C^\dagger.P.C$.
Schrödinger picture evolves the Pauli as $P^\prime = C.P.C^\dagger$.
**Parameters**
* **other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The Clifford operator to evolve by.
* **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – a list of qubits to apply the Clifford to.
* **frame** (*string*) – `'h'` for Heisenberg (default) or `'s'` for Schrödinger framework.
**Returns**
the Pauli $C^\dagger.P.C$ (Heisenberg picture) or the Pauli $C.P.C^\dagger$ (Schrödinger picture).
**Return type**
[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")
**Raises**
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the Clifford number of qubits and qargs don’t match.
</Function>
### expand
<Function id="qiskit.quantum_info.PauliList.expand" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L682-L703" signature="expand(other)">
Return the expand product of each Pauli in the list.
**Parameters**
**other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList.
**Returns**
the list of tensor product Paulis.
**Return type**
[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")
**Raises**
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if other cannot be converted to a PauliList, does not have either 1 or the same number of Paulis as the current list.
</Function>
### from\_symplectic
<Function id="qiskit.quantum_info.PauliList.from_symplectic" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L1111-L1126" signature="from_symplectic(z, x, phase=0)" modifiers="classmethod">
Construct a PauliList from a symplectic data.
**Parameters**
* **z** (*np.ndarray*) – 2D boolean Numpy array.
* **x** (*np.ndarray*) – 2D boolean Numpy array.
* **phase** (*np.ndarray or None*) – Optional, 1D integer array from Z\_4.
**Returns**
the constructed PauliList.
**Return type**
[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")
</Function>
### group\_commuting
<Function id="qiskit.quantum_info.PauliList.group_commuting" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L1211-L1231" signature="group_commuting(qubit_wise=False)">
Partition a PauliList into sets of commuting Pauli strings.
**Parameters**
**qubit\_wise** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) –
whether the commutation rule is applied to the whole operator, or on a per-qubit basis. For example:
```python
>>> from qiskit.quantum_info import PauliList
>>> op = PauliList(["XX", "YY", "IZ", "ZZ"])
>>> op.group_commuting()
[PauliList(['XX', 'YY']), PauliList(['IZ', 'ZZ'])]
>>> op.group_commuting(qubit_wise=True)
[PauliList(['XX']), PauliList(['YY']), PauliList(['IZ', 'ZZ'])]
```
**Returns**
List of PauliLists where each PauliList contains commuting Pauli operators.
**Return type**
[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")]
</Function>
### group\_qubit\_wise\_commuting
<Function id="qiskit.quantum_info.PauliList.group_qubit_wise_commuting" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L1203-L1209" signature="group_qubit_wise_commuting()">
Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings.
**Returns**
List of PauliLists where each PauliList contains commutable Pauli operators.
**Return type**
[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")]
</Function>
### input\_dims
<Function id="qiskit.quantum_info.PauliList.input_dims" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/base_operator.py#L135-L137" signature="input_dims(qargs=None)">
Return tuple of input dimension for specified subsystems.
</Function>
### insert
<Function id="qiskit.quantum_info.PauliList.insert" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L406-L471" signature="insert(ind, value, qubit=False)">
Insert Paulis into the table.
When inserting qubits the qubit index is the same as the column index of the underlying `X` and `Z` arrays.
**Parameters**
* **ind** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – index to insert at.
* **value** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – values to insert.
* **qubit** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if `True` insert qubit columns, otherwise insert Pauli rows (Default: `False`).
**Returns**
the resulting table with the entries inserted.
**Return type**
[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")
**Raises**
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the insertion index is invalid.
</Function>
### inverse
<Function id="qiskit.quantum_info.PauliList.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L825-L827" signature="inverse()">
Return the inverse of each Pauli in the list.
</Function>
### label\_iter
<Function id="qiskit.quantum_info.PauliList.label_iter" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L1056-L1076" signature="label_iter()">
Return a label representation iterator.
This is a lazy iterator that converts each row into the string label only as it is used. To convert the entire table to labels use the [`to_labels()`](#qiskit.quantum_info.PauliList.to_labels "qiskit.quantum_info.PauliList.to_labels") method.
**Returns**
label iterator object for the PauliList.
**Return type**
LabelIterator
</Function>
### matrix\_iter
<Function id="qiskit.quantum_info.PauliList.matrix_iter" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L1078-L1105" signature="matrix_iter(sparse=False)">
Return a matrix representation iterator.
This is a lazy iterator that converts each row into the Pauli matrix representation only as it is used. To convert the entire table to matrices use the [`to_matrix()`](#qiskit.quantum_info.PauliList.to_matrix "qiskit.quantum_info.PauliList.to_matrix") method.
**Parameters**
**sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – optionally return sparse CSR matrices if `True`, otherwise return Numpy array matrices (Default: `False`)
**Returns**
matrix iterator object for the PauliList.
**Return type**
MatrixIterator
</Function>
### noncommutation\_graph
<Function id="qiskit.quantum_info.PauliList.noncommutation_graph" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L1159-L1179" signature="noncommutation_graph(qubit_wise)">
Create the non-commutation graph of this PauliList.
This transforms the measurement operator grouping problem into graph coloring problem. The constructed graph contains one node for each Pauli. The nodes will be connecting for any two Pauli terms that do \_not\_ commute.
**Parameters**
**qubit\_wise** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – whether the commutation rule is applied to the whole operator, or on a per-qubit basis.
**Returns**
**the non-commutation graph with nodes for each Pauli and edges**
indicating a non-commutation relation. Each node will hold the index of the Pauli term it corresponds to in its data. The edges of the graph hold no data.
**Return type**
[rustworkx.PyGraph](https://www.rustworkx.org/apiref/rustworkx.PyGraph.html#rustworkx.PyGraph "(in rustworkx v0.14)")
</Function>
### output\_dims
<Function id="qiskit.quantum_info.PauliList.output_dims" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/base_operator.py#L139-L141" signature="output_dims(qargs=None)">
Return tuple of output dimension for specified subsystems.
</Function>
### power
<Function id="qiskit.quantum_info.PauliList.power" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/mixins/group.py#L151-L171" signature="power(n)">
Return the compose of a operator with itself n times.
**Parameters**
**n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – the number of times to compose with self (n>0).
**Returns**
the n-times composed operator.
**Return type**
[Clifford](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")
**Raises**
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the input and output dimensions of the operator are not equal, or the power is not a positive integer.
</Function>
### reshape
<Function id="qiskit.quantum_info.PauliList.reshape" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/base_operator.py#L106-L133" signature="reshape(input_dims=None, output_dims=None, num_qubits=None)">
Return a shallow copy with reshaped input and output subsystem dimensions.
**Parameters**
* **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None].
* **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None].
* **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – reshape to an N-qubit operator \[Default: None].
**Returns**
returns self with reshaped input and output dimensions.
**Return type**
BaseOperator
**Raises**
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if combined size of all subsystem input dimension or subsystem output dimensions is not constant.
</Function>
### sort
<Function id="qiskit.quantum_info.PauliList.sort" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L536-L592" signature="sort(weight=False, phase=False)">
Sort the rows of the table.
The default sort method is lexicographic sorting by qubit number. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Paulis of a given weight are still ordered lexicographically.
**Example**
Consider sorting all a random ordering of all 2-qubit Paulis
```python
from numpy.random import shuffle
from qiskit.quantum_info.operators import PauliList
# 2-qubit labels
labels = ['II', 'IX', 'IY', 'IZ', 'XI', 'XX', 'XY', 'XZ',
'YI', 'YX', 'YY', 'YZ', 'ZI', 'ZX', 'ZY', 'ZZ']
# Shuffle Labels
shuffle(labels)
pt = PauliList(labels)
print('Initial Ordering')
print(pt)
# Lexicographic Ordering
srt = pt.sort()
print('Lexicographically sorted')
print(srt)
# Weight Ordering
srt = pt.sort(weight=True)
print('Weight sorted')
print(srt)
```
```python
Initial Ordering
['YX', 'ZZ', 'XZ', 'YI', 'YZ', 'II', 'XX', 'XI', 'XY', 'YY', 'IX', 'IZ',
'ZY', 'ZI', 'ZX', 'IY']
Lexicographically sorted
['II', 'IX', 'IY', 'IZ', 'XI', 'XX', 'XY', 'XZ', 'YI', 'YX', 'YY', 'YZ',
'ZI', 'ZX', 'ZY', 'ZZ']
Weight sorted
['II', 'IX', 'IY', 'IZ', 'XI', 'YI', 'ZI', 'XX', 'XY', 'XZ', 'YX', 'YY',
'YZ', 'ZX', 'ZY', 'ZZ']
```
**Parameters**
* **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – optionally sort by weight if `True` (Default: `False`).
* **phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Optionally sort by phase before weight or order (Default: `False`).
**Returns**
a sorted copy of the original table.
**Return type**
[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")
</Function>
### tensor
<Function id="qiskit.quantum_info.PauliList.tensor" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L664-L680" signature="tensor(other)">
Return the tensor product with each Pauli in the list.
**Parameters**
**other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList.
**Returns**
the list of tensor product Paulis.
**Return type**
[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")
**Raises**
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if other cannot be converted to a PauliList, does not have either 1 or the same number of Paulis as the current list.
</Function>
### to\_labels
<Function id="qiskit.quantum_info.PauliList.to_labels" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L954-L1000" signature="to_labels(array=False)">
Convert a PauliList to a list Pauli string labels.
For large PauliLists converting using the `array=True` kwarg will be more efficient since it allocates memory for the full Numpy array of labels in advance.
| Label | Symplectic | Matrix |
| ----- | ---------- | ----------------------------------------------- |
| `"I"` | $[0, 0]$ | $\begin{bmatrix} 1 & 0 \\ 0 & 1 \end{bmatrix}$ |
| `"X"` | $[1, 0]$ | $\begin{bmatrix} 0 & 1 \\ 1 & 0 \end{bmatrix}$ |
| `"Y"` | $[1, 1]$ | $\begin{bmatrix} 0 & -i \\ i & 0 \end{bmatrix}$ |
| `"Z"` | $[0, 1]$ | $\begin{bmatrix} 1 & 0 \\ 0 & -1 \end{bmatrix}$ |
**Parameters**
**array** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – return a Numpy array if `True`, otherwise return a list (Default: `False`).
**Returns**
The rows of the PauliList in label form.
**Return type**
[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)") or array
</Function>
### to\_matrix
<Function id="qiskit.quantum_info.PauliList.to_matrix" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L1002-L1050" signature="to_matrix(sparse=False, array=False)">
Convert to a list or array of Pauli matrices.
For large PauliLists converting using the `array=True` kwarg will be more efficient since it allocates memory a full rank-3 Numpy array of matrices in advance.
| Label | Symplectic | Matrix |
| ----- | ---------- | ----------------------------------------------- |
| `"I"` | $[0, 0]$ | $\begin{bmatrix} 1 & 0 \\ 0 & 1 \end{bmatrix}$ |
| `"X"` | $[1, 0]$ | $\begin{bmatrix} 0 & 1 \\ 1 & 0 \end{bmatrix}$ |
| `"Y"` | $[1, 1]$ | $\begin{bmatrix} 0 & -i \\ i & 0 \end{bmatrix}$ |
| `"Z"` | $[0, 1]$ | $\begin{bmatrix} 1 & 0 \\ 0 & -1 \end{bmatrix}$ |
**Parameters**
* **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if `True` return sparse CSR matrices, otherwise return dense Numpy arrays (Default: `False`).
* **array** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – return as rank-3 numpy array if `True`, otherwise return a list of Numpy arrays (Default: `False`).
**Returns**
A list of dense Pauli matrices if ```array=False` and ``sparse=False`. list: A list of sparse Pauli matrices if ``array=False``` and `sparse=True`. array: A dense rank-3 array of Pauli matrices if `array=True`.
**Return type**
[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")
</Function>
### transpose
<Function id="qiskit.quantum_info.PauliList.transpose" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L817-L819" signature="transpose()">
Return the transpose of each Pauli in the list.
</Function>
### unique
<Function id="qiskit.quantum_info.PauliList.unique" github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/quantum_info/operators/symplectic/pauli_list.py#L594-L658" signature="unique(return_index=False, return_counts=False)">
Return unique Paulis from the table.
**Example**
```python
from qiskit.quantum_info.operators import PauliList
pt = PauliList(['X', 'Y', '-X', 'I', 'I', 'Z', 'X', 'iZ'])
unique = pt.unique()
print(unique)
```
```python
['X', 'Y', '-X', 'I', 'Z', 'iZ']
```
**Parameters**
* **return\_index** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If `True`, also return the indices that result in the unique array. (Default: `False`)
* **return\_counts** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If `True`, also return the number of times each unique item appears in the table.
**Returns**
**unique**
the table of the unique rows.
**unique\_indices: np.ndarray, optional**
The indices of the first occurrences of the unique values in the original array. Only provided if `return_index` is `True`.
**unique\_counts: np.array, optional**
The number of times each of the unique values comes up in the original array. Only provided if `return_counts` is `True`.
**Return type**
[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")
</Function>
</Class>
Reference in New Issue View Git Blame Copy Permalink