qml.PauliX¶

class PauliX(wires)[source]

The Pauli X operator

$\begin{split}\sigma_x = \begin{bmatrix} 0 & 1 \\ 1 & 0\end{bmatrix}.\end{split}$

Details:

• Number of wires: 1

• Number of parameters: 0

Parameters

wires (Sequence[int] or int) – the wire the operation acts on

 base_name Get base name of the operator. basis The basis of an operation, or for controlled gates, of the target operation. control_wires Returns the control wires. eigvals generator Generator of the operation. grad_method Gradient computation method. grad_recipe Gradient recipe for the parameter-shift method. hash returns an integer hash uniquely representing the operator id String for the ID of the operator. inverse Boolean determining if the inverse of the operation was requested. matrix name Get and set the name of the operator. num_params Number of trainable parameters that this operator expects to be fed via the dynamic *params argument. num_wires parameters Current parameter values. return_type string_for_inverse wires Wires of this operator.
base_name

Get base name of the operator.

basis = 'X'

The basis of an operation, or for controlled gates, of the target operation. If not None, should take a value of "X", "Y", or "Z".

For example, X and CNOT have basis = "X", whereas ControlledPhaseShift and RZ have basis = "Z".

Type

str or None

control_wires

Returns the control wires. For operations that are not controlled, this is an empty Wires object of length 0.

Returns

The control wires of the operation.

Return type

Wires

eigvals = array([ 1, -1])
generator

Generator of the operation.

A length-2 list [generator, scaling_factor], where

• generator is an existing PennyLane operation class or $$2\times 2$$ Hermitian array that acts as the generator of the current operation

• scaling_factor represents a scaling factor applied to the generator operation

For example, if $$U(\theta)=e^{i0.7\theta \sigma_x}$$, then $$\sigma_x$$, with scaling factor $$s$$, is the generator of operator $$U(\theta)$$:

generator = [PauliX, 0.7]

Default is [None, 1], indicating the operation has no generator.

• 'A': analytic differentiation using the parameter-shift method.

• 'F': finite difference numerical differentiation.

• None: the operation may not be differentiated.

Default is 'F', or None if the Operation has zero parameters.

Gradient recipe for the parameter-shift method.

This is a tuple with one nested list per operation parameter. For parameter $$\phi_k$$, the nested list contains elements of the form $$[c_i, a_i, s_i]$$ where $$i$$ is the index of the term, resulting in a gradient recipe of

$\frac{\partial}{\partial\phi_k}f = \sum_{i} c_i f(a_i \phi_k + s_i).$

If None, the default gradient recipe containing the two terms $$[c_0, a_0, s_0]=[1/2, 1, \pi/2]$$ and $$[c_1, a_1, s_1]=[-1/2, 1, -\pi/2]$$ is assumed for every parameter.

Type

tuple(Union(list[list[float]], None)) or None

hash

returns an integer hash uniquely representing the operator

Type

int

id

String for the ID of the operator.

inverse

Boolean determining if the inverse of the operation was requested.

matrix = array([[0, 1],        [1, 0]])
name

Get and set the name of the operator.

num_params
num_wires = 1
parameters

Current parameter values.

return_type = None
string_for_inverse = '.inv'
wires

Wires of this operator.

Returns

wires

Return type

Wires

 adjoint() Create an operation that is the adjoint of this one. compare(other) Compares with another Hamiltonian, Tensor, or Observable, to determine if they are equivalent. Decomposes this operator into products of other operators. decomposition(wires) Defines a decomposition of this operator into products of other operators. Rotates the specified wires such that they are in the eigenbasis of the Pauli-X operator. expand() Returns a tape containing the decomposed operations, rather than a list. get_parameter_shift(idx[, shift]) Multiplier and shift for the given parameter, based on its gradient recipe. inv() Inverts the operation, such that the inverse will be used for the computations by the specific device. label([decimals, base_label]) A customizable string representation of the operator. queue([context]) Append the operator to the Operator queue. The parameters required to implement a single-qubit gate as an equivalent Rot gate, up to a global phase.

Create an operation that is the adjoint of this one.

Adjointed operations are the conjugated and transposed version of the original operation. Adjointed ops are equivalent to the inverted operation for unitary gates.

Parameters

do_queue – Whether to add the adjointed gate to the context queue.

Returns

compare(other)

Compares with another Hamiltonian, Tensor, or Observable, to determine if they are equivalent.

Observables/Hamiltonians are equivalent if they represent the same operator (their matrix representations are equal), and they are defined on the same wires.

Warning

The compare method does not check if the matrix representation of a Hermitian observable is equal to an equivalent observable expressed in terms of Pauli matrices. To do so would require the matrix form of Hamiltonians and Tensors be calculated, which would drastically increase runtime.

Returns

True if equivalent.

Return type

(bool)

Examples

>>> ob1 = qml.PauliX(0) @ qml.Identity(1)
>>> ob2 = qml.Hamiltonian(, [qml.PauliX(0)])
>>> ob1.compare(ob2)
True
>>> ob1 = qml.PauliX(0)
>>> ob2 = qml.Hermitian(np.array([[0, 1], [1, 0]]), 0)
>>> ob1.compare(ob2)
False
decompose()

Decomposes this operator into products of other operators.

Returns

list[Operation]

static decomposition(wires)[source]

Defines a decomposition of this operator into products of other operators.

Parameters
• params (tuple[float, int, array]) – operator parameters

• wires (Union(Sequence[int], Wires)) – wires the operator acts on

Returns

list[Operation]

diagonalizing_gates()[source]

Rotates the specified wires such that they are in the eigenbasis of the Pauli-X operator.

For the Pauli-X operator,

$X = H^\dagger Z H.$
Returns

A list of gates that diagonalize PauliY in the computational basis.

Return type

list(qml.Operation)

expand()

Returns a tape containing the decomposed operations, rather than a list.

Returns

Returns a quantum tape that contains the operations decomposition, or if not implemented, simply the operation itself.

Return type

JacobianTape

get_parameter_shift(idx, shift=1.5707963267948966)

Multiplier and shift for the given parameter, based on its gradient recipe.

Parameters

idx (int) – parameter index

Returns

list of multiplier, coefficient, shift for each term in the gradient recipe

Return type

list[[float, float, float]]

inv()

Inverts the operation, such that the inverse will be used for the computations by the specific device.

This method concatenates a string to the name of the operation, to indicate that the inverse will be used for computations.

Any subsequent call of this method will toggle between the original operation and the inverse of the operation.

Returns

operation to be inverted

Return type

Operator

label(decimals=None, base_label=None)[source]

A customizable string representation of the operator.

Parameters
• decimals=None (int) – If None, no parameters are included. Else, specifies how to round the parameters.

• base_label=None (str) – overwrite the non-parameter component of the label

Returns

label to use in drawings

Return type

str

Example:

>>> op = qml.RX(1.23456, wires=0)
>>> op.label()
"RX"
>>> op.label(decimals=2)
"RX\n(1.23)"
>>> op.label(base_label="my_label")
"my_label"
>>> op.label(decimals=2, base_label="my_label")
"my_label\n(1.23)"
>>> op.inv()
>>> op.label()
"RX⁻¹"
queue(context=<class 'pennylane.queuing.QueuingContext'>)

Append the operator to the Operator queue.

single_qubit_rot_angles()[source]

The parameters required to implement a single-qubit gate as an equivalent Rot gate, up to a global phase.

Returns

A list of values $$[\phi, \theta, \omega]$$ such that $$RZ(\omega) RY(\theta) RZ(\phi)$$ is equivalent to the original operation.

Return type

tuple[float, float, float]