# qml.SingleExcitation¶

class SingleExcitation(phi, wires)[source]

Single excitation rotation.

$\begin{split}U(\phi) = \begin{bmatrix} 1 & 0 & 0 & 0 \\ 0 & \cos(\phi/2) & -\sin(\phi/2) & 0 \\ 0 & \sin(\phi/2) & \cos(\phi/2) & 0 \\ 0 & 0 & 0 & 1 \end{bmatrix}.\end{split}$

This operation performs a rotation in the two-dimensional subspace $$\{|01\rangle, |10\rangle\}$$. The name originates from the occupation-number representation of fermionic wavefunctions, where the transformation from $$|10\rangle$$ to $$|01\rangle$$ is interpreted as “exciting” a particle from the first qubit to the second.

Details:

Parameters
• phi (float) – rotation angle $$\phi$$

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

Example

The following circuit performs the transformation $$|10\rangle\rightarrow \cos( \phi/2)|10\rangle -\sin(\phi/2)|01\rangle$$:

dev = qml.device('default.qubit', wires=2)

@qml.qnode(dev)
def circuit(phi):
qml.PauliX(wires=0)
qml.SingleExcitation(phi, wires=[0, 1])
return qml.state()

circuit(0.1)

 base_name Get base name of the operator. eigvals Eigenvalues of an instantiated operator. generator grad_method grad_recipe Gradient recipe for the parameter-shift method. inverse Boolean determining if the inverse of the operation was requested. matrix Matrix representation of an instantiated operator in the computational basis. name Get and set the name of the operator. num_params num_wires par_domain parameters Current parameter values. string_for_inverse wires Wires of this operator.
base_name

Get base name of the operator.

eigvals
generator = [array([[ 0.+0.j,  0.+0.j,  0.+0.j,  0.+0.j],        [ 0.+0.j,  0.+0.j, -0.-1.j,  0.+0.j],        [ 0.+0.j,  0.+1.j,  0.+0.j,  0.+0.j],        [ 0.+0.j,  0.+0.j,  0.+0.j,  0.+0.j]]), -0.5]
grad_method = 'A'
grad_recipe = None

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

inverse

Boolean determining if the inverse of the operation was requested.

matrix
name

Get and set the name of the operator.

num_params = 1
num_wires = 2
par_domain = 'R'
parameters

Current parameter values.

string_for_inverse = '.inv'
wires

Wires of this operator.

Returns

wires

Return type

Wires

 Create an operation that is the adjoint of this one. decomposition(theta, wires) Returns a template decomposing the operation into other quantum operations. 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. Inverts the operation, such that the inverse will be used for the computations by the specific device. Append the operator to the Operator queue.
adjoint()[source]

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

static decomposition(theta, wires)[source]

Returns a template decomposing the operation into other quantum operations.

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

multiplier, shift

Return type

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

queue()

Append the operator to the Operator queue.