Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

PermutationGate

PermutationGate(pattern)

GitHub(opens in a new tab)

Bases: qiskit.circuit.gate.Gate

A gate that permutes qubits.

Return a permutation gate.

Parameters

pattern (List[int]) – permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation, that is pattern[k] = m when the permutation maps qubit m to position k. As an example, the pattern [2, 4, 3, 0, 1] means that qubit 2 goes to position 0, qubit 4 goes to the position 1, etc.

Raises

CircuitError – if permutation pattern is malformed.

Reference Circuit:

(Source code, png, hires.png, pdf)

../_images/qiskit-circuit-library-PermutationGate-1.png

Expanded Circuit:

(Source code, png, hires.png, pdf)

../_images/qiskit-circuit-library-PermutationGate-2.png

Methods Defined Here

inverse

PermutationGate.inverse()

Returns the inverse of the permutation.

qasm

PermutationGate.qasm()

The qasm for a permutation.

validate_parameter

PermutationGate.validate_parameter(parameter)

Parameter validation.


Attributes

condition_bits

Get Clbits in condition.

Return type

List[Clbit]

decompositions

Get the decompositions of the instruction from the SessionEquivalenceLibrary.

definition

Return definition in terms of other basic gates.

duration

Get the duration.

label

Return instruction label

Return type

str

name

Return the name.

num_clbits

Return the number of clbits.

num_qubits

Return the number of qubits.

params

return instruction params.

pattern

Returns the permutation pattern defining this permutation.

unit

Get the time unit of duration.

Was this page helpful?
Report a bug or request content on GitHub.