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


class BasicSwap(*args, **kwargs)

GitHub(opens in a new tab)

Bases: qiskit.transpiler.basepasses.TransformationPass

Map (with minimum effort) a DAGCircuit onto a coupling_map adding swap gates.

The basic mapper is a minimum effort to insert swap gates to map the DAG onto a coupling map. When a cx is not in the coupling map possibilities, it inserts one or more swaps in front to make it compatible.

BasicSwap initializer.


  • coupling_map (CouplingMap) – Directed graph represented a coupling map.
  • fake_run (bool) – if true, it only pretend to do routing, i.e., no swap is effectively added.



Return the name of the pass.


Run the BasicSwap pass on dag.


dag (DAGCircuit) – DAG to map.


A mapped DAG.

Return type



  • TranspilerError – if the coupling map or the layout are not
  • compatible with the DAG.



Check if the pass is an analysis pass.

If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.


Check if the pass is a transformation pass.

If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).

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