Skip to main content
IBM Quantum Platform
This page is from an old version of Qiskit SDK Go to the latest version

Permutation

class Permutation(num_qubits, pattern=None, seed=None)

GitHub

Bases: qiskit.circuit.quantumcircuit.QuantumCircuit

An n_qubit circuit that permutes qubits.

Return an n_qubit permutation circuit implemented using SWAPs.

Parameters

  • num_qubits (int) – circuit width.
  • pattern (Optional[List[int]]) – permutation pattern. If None, permute randomly.
  • seed (Optional[int]) – random seed in case a random permutation is requested.

Raises

CircuitError – if permutation pattern is malformed.

Reference Circuit:

../_images/qiskit.circuit.library.Permutation_0_0.png

Expanded Circuit:


Attributes

ancillas

Returns a list of ancilla bits in the order that the registers were added.

calibrations

Return calibration dictionary.

The custom pulse definition of a given gate is of the form

{‘gate_name’: {(qubits, params): schedule}}

clbits

Returns a list of classical bits in the order that the registers were added.

data

Return the circuit data (instructions and context).

Returns

a list-like object containing the tuples for the circuit’s data.

Each tuple is in the format (instruction, qargs, cargs), where instruction is an Instruction (or subclass) object, qargs is a list of Qubit objects, and cargs is a list of Clbit objects.

Return type

QuantumCircuitData

extension_lib

Default value: 'include "qelib1.inc";'

global_phase

Return the global phase of the circuit in radians.

Default value: 'OPENQASM 2.0;'

instances

Default value: 16

metadata

The user provided metadata associated with the circuit

The metadata for the circuit is a user provided dict of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit.

num_ancillas

Return the number of ancilla qubits.

num_clbits

Return number of classical bits.

num_parameters

Convenience function to get the number of parameter objects in the circuit.

num_qubits

Return number of qubits.

parameters

Convenience function to get the parameters defined in the parameter table.

prefix

Default value: 'circuit'

qubits

Returns a list of quantum bits in the order that the registers were added.

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