CheckMap

class qiskit.transpiler.passes.CheckMap(*args, **kwargs)[source]

Bases: AnalysisPass

Check if a DAG circuit is already mapped to a coupling map.

Check if a DAGCircuit is mapped to coupling_map by checking that all 2-qubit interactions are laid out to be on adjacent qubits in the global coupling map of the device, setting the property set field (either specified with property_set_field or the default is_swap_mapped) to True or False accordingly. Note this does not validate directionality of the connectivity between qubits. If you need to check gates are implemented in a native direction for a target use the CheckGateDirection pass instead.

CheckMap initializer.

Parameters:

  • coupling_map (Union[CouplingMap, Target]) – Directed graph representing a coupling map.

  • property_set_field (str) – An optional string to specify the property set field to store the result of the check. If not default the result is stored in "is_swap_mapped".

Attributes

is_analysis_pass

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.

is_transformation_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).

Methods

execute(passmanager_ir, state, callback=None)

Execute optimization task for input Qiskit IR.

Parameters:

  • passmanager_ir (Any) – Qiskit IR to optimize.

  • state (PassManagerState) – State associated with workflow execution by the pass manager itself.

  • callback (Callable | None) – A callback function which is caller per execution of optimization task.

Returns:

Optimized Qiskit IR and state of the workflow.

Return type:

tuple[Any, qiskit.passmanager.compilation_status.PassManagerState]

name()

Name of the pass.

Return type:

str

run(dag)[source]

Run the CheckMap pass on dag.

If dag is mapped to coupling_map, the property is_swap_mapped is set to True (or to False otherwise).

Parameters:

dag (DAGCircuit) – DAG to map.

update_status(state, run_state)

Update workflow status.

Parameters:

  • state (PassManagerState) – Pass manager state to update.

  • run_state (RunState) – Completion status of current task.

Returns:

Updated pass manager state.

Return type:

PassManagerState