qml.pauli.are_identical_pauli_words¶

are_identical_pauli_words(pauli_1, pauli_2)[source]¶

Performs a check if two Pauli words have the same wires and name attributes.

This is a convenience function that checks if two given Prod instances specify the same Pauli word.

Parameters:

pauli_1 (Union[Identity, PauliX, PauliY, PauliZ, Prod, SProd]) – the first Pauli word
pauli_2 (Union[Identity, PauliX, PauliY, PauliZ, Prod, SProd]) – the second Pauli word

Returns:

whether pauli_1 and pauli_2 have the same wires and name attributes

Return type:

bool

Raises:

TypeError – if pauli_1 or pauli_2 are not Identity, PauliX, PauliY, PauliZ, SProd, or Prod instances

Example

>>> are_identical_pauli_words(qml.Z(0) @ qml.Z(1), qml.Z(1) @ qml.Z(0))
True
>>> are_identical_pauli_words(qml.I(0) @ qml.X(1), qml.X(1))
True
>>> are_identical_pauli_words(qml.Z(0) @ qml.Z(1), qml.Z(0) @ qml.X(3))
False

code/api/pennylane.pauli.are_identical_pauli_words

Download Python script

Download Notebook

View on GitHub

qml.pauli.are_identical_pauli_words¶

Contents