# openfermion.circuits.FSwapPowGate

The FSWAP gate, possibly raised to a power.

FSwapPowGate()**t = FSwapPowGate(exponent=t) and acts on two qubits in the computational basis as the matrix:

``````[[1, 0, 0, 0],
[0, g·c, -i·g·s, 0],
[0, -i·g·s, g·c, 0],
[0, 0, 0, p]]
``````

where:

``````c = cos(π·t/2)
s = sin(π·t/2)
g = exp(i·π·t/2)
p = exp(i·π·t).
``````

`openfermion.FSWAP` is an instance of this gate at exponent=1. It swaps adjacent fermionic modes under the Jordan-Wigner Transform.

`exponent` The t in gate**t. Determines how much the eigenvalues of the gate are phased by. For example, eigenvectors phased by -1 when `gate**1` is applied will gain a relative phase of e^{i pi exponent} when `gate**exponent` is applied (relative to eigenvectors unaffected by `gate**1`).
`global_shift` Offsets the eigenvalues of the gate at exponent=1. In effect, this controls a global phase factor on the gate's unitary matrix. The factor is:

``````exp(i * pi * global_shift * exponent)
``````

For example, `cirq.X**t` uses a `global_shift` of 0 but `cirq.rx(t)` uses a `global_shift` of -0.5, which is why `cirq.unitary(cirq.rx(pi))` equals -iX instead of X.

`ValueError` If the supplied exponent is a complex number with an imaginary component.

`exponent`

`global_shift`

## Methods

### `controlled`

Returns a controlled version of this gate. If no arguments are specified, defaults to a single qubit control.

Args
`num_controls` Total number of control qubits.
`control_values` Which control computational basis state to apply the sub gate. A sequence of length `num_controls` where each entry is an integer (or set of integers) corresponding to the computational basis state (or set of possible values) where that control is enabled. When all controls are enabled, the sub gate is applied. If unspecified, control values default to 1.
`control_qid_shape` The qid shape of the controls. A tuple of the expected dimension of each control qid. Defaults to `(2,) * num_controls`. Specify this argument when using qudits.

Returns
A `cirq.Gate` representing `self` controlled by the given control values and qubits. This is a `cirq.ControlledGate` in the base implementation, but subclasses may return a different gate type.

### `num_qubits`

View source

The number of qubits this gate acts on.

### `on`

Returns an application of this gate to the given qubits.

Args
`*qubits` The collection of qubits to potentially apply the gate to.

Returns: a `cirq.Operation` which is this gate applied to the given qubits.

### `on_each`

Returns a list of operations applying the gate to all targets.

Args
`*targets` The qubits to apply this gate to. For single-qubit gates this can be provided as varargs or a combination of nested iterables. For multi-qubit gates this must be provided as an `Iterable[Sequence[Qid]]`, where each sequence has `num_qubits` qubits.

Returns
Operations applying this gate to the target qubits.

Raises
`ValueError` If targets are not instances of Qid or Iterable[Qid]. If the gate qubit number is incompatible.
`TypeError` If a single target is supplied and it is not iterable.

### `qubit_index_to_equivalence_group_key`

Returns a key that differs between non-interchangeable qubits.

### `validate_args`

Checks if this gate can be applied to the given qubits.

By default checks that:

• inputs are of type `Qid`
• len(qubits) == num_qubits()
• qubit_i.dimension == qid_shape[i] for all qubits

Child classes can override. The child implementation should call `super().validate_args(qubits)` then do custom checks.

Args
`qubits` The sequence of qubits to potentially apply the gate to.

Raises
`ValueError` The gate can't be applied to the qubits.

### `with_probability`

Creates a probabilistic channel with this gate.

Args
`probability` floating point value between 0 and 1, giving the probability this gate is applied.

Returns
`cirq.RandomGateChannel` that applies `self` with probability `probability` and the identity with probability `1-p`.

### `wrap_in_linear_combination`

Returns a LinearCombinationOfGates with this gate.

Args
`coefficient` number coefficient to use in the resulting `cirq.LinearCombinationOfGates` object.

Returns
`cirq.LinearCombinationOfGates` containing self with a coefficient of `coefficient`.

### `__call__`

Call self as a function.

### `__truediv__`

[{ "type": "thumb-down", "id": "missingTheInformationINeed", "label":"Missing the information I need" },{ "type": "thumb-down", "id": "tooComplicatedTooManySteps", "label":"Too complicated / too many steps" },{ "type": "thumb-down", "id": "outOfDate", "label":"Out of date" },{ "type": "thumb-down", "id": "samplesCodeIssue", "label":"Samples / code issue" },{ "type": "thumb-down", "id": "otherDown", "label":"Other" }]
[{ "type": "thumb-up", "id": "easyToUnderstand", "label":"Easy to understand" },{ "type": "thumb-up", "id": "solvedMyProblem", "label":"Solved my problem" },{ "type": "thumb-up", "id": "otherUp", "label":"Other" }]
{"lastModified": "Last updated 2024-04-26 UTC."}