qiskit.quantum_info.Pauli

class Pauli(data=None, x=None, *, z=None, label=None)

N-qubit Pauli operator.

This class represents an operator \(P\) from the full \(n\)-qubit Pauli group

\[P = (-i)^{q} P_{n-1} \otimes ... \otimes P_{0}\]

where \(q\in \mathbb{Z}_4\) and \(P_i \in \{I, X, Y, Z\}\) are single-qubit Pauli matrices:

\[\begin{split}I = \begin{pmatrix} 1 & 0 \\ 0 & 1 \end{pmatrix}, X = \begin{pmatrix} 0 & 1 \\ 1 & 0 \end{pmatrix}, Y = \begin{pmatrix} 0 & -i \\ i & 0 \end{pmatrix}, Z = \begin{pmatrix} 1 & 0 \\ 0 & -1 \end{pmatrix}.\end{split}\]

Initialization

A Pauli object can be initialized in several ways:

Pauli(obj)

where obj is a Pauli string, Pauli or ScalarOp operator, or a Pauli gate or QuantumCircuit containing only Pauli gates.

Pauli((z, x, phase))

where z and x are boolean numpy.ndarrays and phase is an integer in [0, 1, 2, 3].

Pauli((z, x))

equivalent to Pauli((z, x, 0)) with trivial phase.

String representation

An \(n\)-qubit Pauli may be represented by a string consisting of \(n\) characters from ['I', 'X', 'Y', 'Z'], and optionally phase coefficient in \(['', '-i', '-', 'i']\). For example: XYZ or '-iZIZ'.

In the string representation qubit-0 corresponds to the right-most Pauli character, and qubit-\((n-1)\) to the left-most Pauli character. For example 'XYZ' represents \(X\otimes Y \otimes Z\) with 'Z' on qubit-0, 'Y' on qubit-1, and 'X' on qubit-3.

The string representation can be converted to a Pauli using the class initialization (Pauli('-iXYZ')). A Pauli object can be converted back to the string representation using the to_label() method or str(pauli).

Nota

Using str to convert a Pauli to a string will truncate the returned string for large numbers of qubits while to_label() will return the full string with no truncation. The default truncation length is 50 characters. The default value can be changed by setting the class __truncate__ attribute to an integer value. If set to 0 no truncation will be performed.

Array Representation

The internal data structure of an \(n\)-qubit Pauli is two length-\(n\) boolean vectors \(z \in \mathbb{Z}_2^N\), \(x \in \mathbb{Z}_2^N\), and an integer \(q \in \mathbb{Z}_4\) defining the Pauli operator

\[P &= (-i)^{q + z\cdot x} Z^z \cdot X^x.\]

The \(k\) and \(x\) arrays

\[\begin{split}P &= P_{n-1} \otimes ... \otimes P_{0} \\ P_k &= (-i)^{z[k] * x[k]} Z^{z[k]}\cdot X^{x[k]}\end{split}\]

where z[k] = P.z[k], x[k] = P.x[k] respectively.

The \(z\) and \(x\) arrays can be accessed and updated using the z and x properties respectively. The phase integer \(q\) can be accessed and updated using the phase property.

Matrix Operator Representation

Pauli’s can be converted to \((2^n, 2^n)\) Operator using the to_operator() method, or to a dense or sparse complex matrix using the to_matrix() method.

Data Access

The individual qubit Paulis can be accessed and updated using the [] operator which accepts integer, lists, or slices for selecting subsets of Paulis. Note that selecting subsets of Pauli’s will discard the phase of the current Pauli.

For example

Initialize the Pauli.

When using the symplectic array input data both z and x arguments must be provided, however the first (z) argument can be used alone for string label, Pauli operator, or ScalarOp input data.

Parâmetros

• data (str or tuple or Pauli or ScalarOp) – input data for Pauli. If input is a tuple it must be of the form (z, x) or (z, x, phase)`` where z and x are boolean Numpy arrays, and phase is an integer from Z_4.

• x (np.ndarray) – DEPRECATED, symplectic x vector.

• z (np.ndarray) – DEPRECATED, symplectic z vector.

• label (str) – DEPRECATED, string label.

Levanta

QiskitError – if input array is invalid shape.

__init__(data=None, x=None, *, z=None, label=None)

Initialize the Pauli.

When using the symplectic array input data both z and x arguments must be provided, however the first (z) argument can be used alone for string label, Pauli operator, or ScalarOp input data.

Parâmetros

• data (str or tuple or Pauli or ScalarOp) – input data for Pauli. If input is a tuple it must be of the form (z, x) or (z, x, phase)`` where z and x are boolean Numpy arrays, and phase is an integer from Z_4.

• x (np.ndarray) – DEPRECATED, symplectic x vector.

• z (np.ndarray) – DEPRECATED, symplectic z vector.

• label (str) – DEPRECATED, string label.

Levanta

QiskitError – if input array is invalid shape.

Methods

__init__([data, x, z, label])	Initialize the Pauli.
adjoint()	Return the adjoint of the Operator.
anticommutes(other[, qargs])	Return True if other Pauli anticommutes with self.
append_paulis([paulis, pauli_labels])	DEPRECATED: Append pauli at the end.
commutes(other[, qargs])	Return True if the Pauli commutes with other.
compose(other[, qargs, front, inplace])	Return the operator composition with another Pauli.
conjugate()	Return the conjugate of each Pauli in the list.
copy()	Make a deep copy of current operator.
delete(qubits)	Return a Pauli with qubits deleted.
delete_qubits(indices)	DEPRECATED: Delete pauli at the indices.
dot(other[, qargs, inplace])	Return the right multiplied operator self * other.
equiv(other)	Return True if Pauli’s are equivalent up to group phase.
evolve(other[, qargs])	Heisenberg picture evolution of a Pauli by a Clifford.
expand(other)	Return the reverse-order tensor product with another Pauli.
from_label(*args, **kwargs)	DEPRECATED: Construct a Pauli from a string label.
input_dims([qargs])	Return tuple of input dimension for specified subsystems.
insert(qubits, value)	Insert a Pauli at specific qubit value.
insert_paulis([indices, paulis, pauli_labels])	DEPRECATED: Insert or append pauli to the targeted indices.
inverse()	Return the inverse of the Pauli.
kron(other)	DEPRECATED: Kronecker product of two paulis.
output_dims([qargs])	Return tuple of output dimension for specified subsystems.
pauli_single(num_qubits, index, pauli_label)	DEPRECATED: Generate single qubit pauli at index with pauli_label with length num_qubits.
power(n)	Return the compose of a operator with itself n times.
random(num_qubits[, seed])	DEPRECATED: Return a random Pauli on number of qubits.
reshape([input_dims, output_dims, num_qubits])	Return a shallow copy with reshaped input and output subsystem dimensions.
set_truncation(val)	Set the max number of Pauli characters to display before truncation/
sgn_prod(*args, **kwargs)	DEPRECATED: Multiply two Paulis and track the phase.
tensor(other)	Return the tensor product with another Pauli.
to_instruction()	Convert to Pauli circuit instruction.
to_label()	Convert a Pauli to a string label.
to_matrix([sparse])	Convert to a Numpy array or sparse CSR matrix.
to_spmatrix()	DEPRECATED Convert Pauli to a sparse matrix representation (CSR format).
transpose()	Return the transpose of each Pauli in the list.
update_x(x[, indices])	DEPRECATED: Update partial or entire x.
update_z(z[, indices])	DEPRECATED: Update partial or entire z.

Attributes

dim	Return tuple (input_shape, output_shape).
num_qubits	Return the number of qubits if a N-qubit operator or None otherwise.
phase	Return the group phase exponent for the Pauli.
qargs	Return the qargs for the operator.
x	The x vector for the Pauli.
z	The z vector for the Pauli.

adjoint()

Return the adjoint of the Operator.

anticommutes(other, qargs=None)

Return True if other Pauli anticommutes with self.

Parâmetros

• other (Pauli) – another Pauli operator.

• qargs (list) – qubits to apply dot product on (default: None).

Retorna

True if Pauli’s anticommute, False if they commute.

Tipo de retorno

bool

append_paulis(paulis=None, pauli_labels=None)

DEPRECATED: Append pauli at the end.

Parâmetros

• paulis (Pauli) – the to-be-inserted or appended pauli

• pauli_labels (list[str]) – the to-be-inserted or appended pauli label

Retorna

self

Tipo de retorno

Pauli

commutes(other, qargs=None)

Return True if the Pauli commutes with other.

Parâmetros

• other (Pauli or PauliList) – another Pauli operator.

• qargs (list) – qubits to apply dot product on (default: None).

Retorna

True if Pauli’s commute, False if they anti-commute.

Tipo de retorno

bool

compose(other, qargs=None, front=False, inplace=False)

Return the operator composition with another Pauli.

Parâmetros

• other (Pauli) – a Pauli object.

• qargs (list or None) – Optional, qubits to apply dot product on (default: None).

• front (bool) – If True compose using right operator multiplication, instead of left multiplication [default: False].

• inplace (bool) – If True update in-place (default: False).

Retorna

The composed Pauli.

Tipo de retorno

Pauli

Levanta

QiskitError – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems.

Nota

Composition (&) by default is defined as left matrix multiplication for matrix operators, while dot() is defined as right matrix multiplication. That is that A & B == A.compose(B) is equivalent to B.dot(A) when A and B are of the same type.

Setting the front=True kwarg changes this to right matrix multiplication and is equivalent to the dot() method A.dot(B) == A.compose(B, front=True).

conjugate()

Return the conjugate of each Pauli in the list.

copy()

Make a deep copy of current operator.

delete(qubits)

Return a Pauli with qubits deleted.

Parâmetros

qubits (int or list) – qubits to delete from Pauli.

Retorna

the resulting Pauli with the specified qubits removed.

Tipo de retorno

Pauli

Levanta

QiskitError – if ind is out of bounds for the array size or number of qubits.

delete_qubits(indices)

DEPRECATED: Delete pauli at the indices.

This function is deprecated. Equivalent functionality can be obtained using the delete() method.

Parâmetros

indices (list[int]) – the indices of to-be-deleted paulis

Retorna

self

Tipo de retorno

Pauli

property dim

Return tuple (input_shape, output_shape).

dot(other, qargs=None, inplace=False)

Return the right multiplied operator self * other.

Parâmetros

• other (Pauli) – an operator object.

• qargs (list or None) – Optional, qubits to apply dot product on (default: None).

• inplace (bool) – If True update in-place (default: False).

Retorna

The operator self * other.

Tipo de retorno

Pauli

equiv(other)

Return True if Pauli’s are equivalent up to group phase.

Parâmetros

other (Pauli) – an operator object.

Retorna

True if the Pauli’s are equivalent up to group phase.

Tipo de retorno

bool

evolve(other, qargs=None)

Heisenberg picture evolution of a Pauli by a Clifford.

This returns the Pauli \(P^\prime = C^\dagger.P.C\).

Parâmetros

• other (Pauli or Clifford or QuantumCircuit) – The Clifford operator to evolve by.

• qargs (list) – a list of qubits to apply the Clifford to.

Retorna

the Pauli \(C^\dagger.P.C\).

Tipo de retorno

Pauli

Levanta

QiskitError – if the Clifford number of qubits and qargs don’t match.

expand(other)

Return the reverse-order tensor product with another Pauli.

Parâmetros

other (Pauli) – a Pauli object.

Retorna

the tensor product \(b \otimes a\), where \(a\)

is the current Pauli, and \(b\) is the other Pauli.

Tipo de retorno

Pauli

static from_label(*args, **kwargs)

DEPRECATED: Construct a Pauli from a string label.

This function is deprecated use Pauli(label) instead.

Parâmetros

label (str) – Pauli string label.

Retorna

the constructed Pauli.

Tipo de retorno

Pauli

Levanta

• QiskitError – If the input list is empty or contains invalid

• Pauli strings. –

input_dims(qargs=None)

Return tuple of input dimension for specified subsystems.

insert(qubits, value)

Insert a Pauli at specific qubit value.

Parâmetros

• qubits (int or list) – qubits index to insert at.

• value (Pauli) – value to insert.

Retorna

the resulting Pauli with the entries inserted.

Tipo de retorno

Pauli

Levanta

QiskitError – if the insertion qubits are invalid.

insert_paulis(indices=None, paulis=None, pauli_labels=None)

DEPRECATED: Insert or append pauli to the targeted indices.

This function is deprecated. Similar functionality can be obtained using the insert() method.

If indices is None, it means append at the end.

Parâmetros

• indices (list[int]) – the qubit indices to be inserted

• paulis (Pauli) – the to-be-inserted or appended pauli

• pauli_labels (list[str]) – the to-be-inserted or appended pauli label

Nota

the indices refers to the location of original paulis, e.g. if indices = [0, 2], pauli_labels = [‘Z’, ‘I’] and original pauli = ‘ZYXI’ the pauli will be updated to ZY’I’XI’Z’ ‘Z’ and ‘I’ are inserted before the qubit at 0 and 2.

Retorna

self

Tipo de retorno

Pauli

Levanta

QiskitError – provide both paulis and pauli_labels at the same time

inverse()

Return the inverse of the Pauli.

kron(other)

DEPRECATED: Kronecker product of two paulis.

This function is deprecated. Use expand() instead.

Order is $P_2 (other) otimes P_1 (self)$

Parâmetros

other (Pauli) – P2

Retorna

self

Tipo de retorno

Pauli

property num_qubits

Return the number of qubits if a N-qubit operator or None otherwise.

output_dims(qargs=None)

Return tuple of output dimension for specified subsystems.

classmethod pauli_single(num_qubits, index, pauli_label)

DEPRECATED: Generate single qubit pauli at index with pauli_label with length num_qubits.

Parâmetros

• num_qubits (int) – the length of pauli

• index (int) – the qubit index to insert the single qubit

• pauli_label (str) – pauli

Retorna

single qubit pauli

Tipo de retorno

Pauli

property phase

Return the group phase exponent for the Pauli.

power(n)

Return the compose of a operator with itself n times.

Parâmetros

n (int) – the number of times to compose with self (n>0).

Retorna

the n-times composed operator.

Tipo de retorno

Pauli

Levanta

QiskitError – if the input and output dimensions of the operator are not equal, or the power is not a positive integer.

property qargs

Return the qargs for the operator.

classmethod random(num_qubits, seed=None)

DEPRECATED: Return a random Pauli on number of qubits.

This function is deprecated use random_pauli() instead.

Parâmetros

• num_qubits (int) – the number of qubits

• seed (int) – Optional. To set a random seed.

Retorna

the random pauli

Tipo de retorno

Pauli

reshape(input_dims=None, output_dims=None, num_qubits=None)

Return a shallow copy with reshaped input and output subsystem dimensions.

Parâmetros

• input_dims (None or tuple) – new subsystem input dimensions. If None the original input dims will be preserved [Default: None].

• output_dims (None or tuple) – new subsystem output dimensions. If None the original output dims will be preserved [Default: None].

• num_qubits (None or int) – reshape to an N-qubit operator [Default: None].

Retorna

returns self with reshaped input and output dimensions.

Tipo de retorno

BaseOperator

Levanta

QiskitError – if combined size of all subsystem input dimension or subsystem output dimensions is not constant.

classmethod set_truncation(val)

Set the max number of Pauli characters to display before truncation/

Parâmetros

val (int) – the number of characters.

Nota

Truncation will be disabled if the truncation value is set to 0.

static sgn_prod(*args, **kwargs)

DEPRECATED: Multiply two Paulis and track the phase.

This function is deprecated. The Pauli class now handles full Pauli group multiplication using compose() or dot().

$P_3 = P_1 otimes P_2$: X*Y

Parâmetros

• p1 (Pauli) – pauli 1

• p2 (Pauli) – pauli 2

Retorna

the multiplied pauli (without phase) complex: the sign of the multiplication, 1, -1, 1j or -1j

Tipo de retorno

Pauli

tensor(other)

Return the tensor product with another Pauli.

Parâmetros

other (Pauli) – a Pauli object.

Retorna

the tensor product \(a \otimes b\), where \(a\)

is the current Pauli, and \(b\) is the other Pauli.

Tipo de retorno

Pauli

Nota

The tensor product can be obtained using the ^ binary operator. Hence a.tensor(b) is equivalent to a ^ b.

to_instruction()

Convert to Pauli circuit instruction.

to_label()

Convert a Pauli to a string label.

Nota

The difference between to_label and __str__() is that the later will truncate the output for large numbers of qubits.

Retorna

the Pauli string label.

Tipo de retorno

str

to_matrix(sparse=False)

Convert to a Numpy array or sparse CSR matrix.

Parâmetros

sparse (bool) – if True return sparse CSR matrices, otherwise return dense Numpy arrays (default: False).

Retorna

The Pauli matrix.

Tipo de retorno

array

to_spmatrix()

DEPRECATED Convert Pauli to a sparse matrix representation (CSR format).

This function is deprecated. Use to_matrix() with kwarg sparse=True instead.

Retorna

a sparse matrix with CSR format that represents the pauli.

Tipo de retorno

scipy.sparse.csr_matrix

transpose()

Return the transpose of each Pauli in the list.

update_x(x, indices=None)

DEPRECATED: Update partial or entire x.

This function is deprecated. Use the setter for X instead.

Parâmetros

• x (numpy.ndarray or list) – to-be-updated x

• indices (numpy.ndarray or list or optional) – to-be-updated qubit indices

Retorna

self

Tipo de retorno

Pauli

Levanta

QiskitError – when updating whole x, the number of qubits must be the same.

update_z(z, indices=None)

DEPRECATED: Update partial or entire z.

This function is deprecated. Use the setter for Z instead.

Parâmetros

• z (numpy.ndarray or list) – to-be-updated z

• indices (numpy.ndarray or list or optional) – to-be-updated qubit indices

Retorna

self

Tipo de retorno

Pauli

Levanta

QiskitError – when updating whole z, the number of qubits must be the same.

property x

The x vector for the Pauli.

property z

The z vector for the Pauli.