PermutationGate
class qiskit.circuit.library.PermutationGate(pattern)
Bases: 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:
![../_images/qiskit-circuit-library-PermutationGate-1.png](/_next/image?url=%2Fimages%2Fapi%2Fqiskit%2F1.0%2Fqiskit-circuit-library-PermutationGate-1.png&w=640&q=75)
Expanded Circuit:
![../_images/qiskit-circuit-library-PermutationGate-2.png](/_next/image?url=%2Fimages%2Fapi%2Fqiskit%2F1.0%2Fqiskit-circuit-library-PermutationGate-2.png&w=1080&q=75)
Attributes
base_class
Get the base class of this instruction. This is guaranteed to be in the inheritance tree of self
.
The “base class” of an instruction is the lowest class in its inheritance tree that the object should be considered entirely compatible with for _all_ circuit applications. This typically means that the subclass is defined purely to offer some sort of programmer convenience over the base class, and the base class is the “true” class for a behavioural perspective. In particular, you should not override base_class
if you are defining a custom version of an instruction that will be implemented differently by hardware, such as an alternative measurement strategy, or a version of a parametrised gate with a particular set of parameters for the purposes of distinguishing it in a Target
from the full parametrised gate.
This is often exactly equivalent to type(obj)
, except in the case of singleton instances of standard-library instructions. These singleton instances are special subclasses of their base class, and this property will return that base. For example:
>>> isinstance(XGate(), XGate)
True
>>> type(XGate()) is XGate
False
>>> XGate().base_class is XGate
True
In general, you should not rely on the precise class of an instruction; within a given circuit, it is expected that Instruction.name
should be a more suitable discriminator in most situations.
condition
The classical condition on the instruction.
condition_bits
Get Clbits in condition.
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
mutable
Is this instance is a mutable unique instance or not.
If this attribute is False
the gate instance is a shared singleton and is not mutable.
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.