qiskit 1.3.0__cp39-abi3-macosx_11_0_arm64.whl

qiskit/transpiler/preset_passmanagers/level0.py

@@ -0,0 +1,113 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2018.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Pass manager for optimization level 0, providing no explicit optimization.
+
+Level 0 pass manager: no explicit optimization other than mapping to backend.
+"""
+
+from qiskit.transpiler.passmanager_config import PassManagerConfig
+from qiskit.transpiler.passmanager import StagedPassManager
+from qiskit.transpiler.preset_passmanagers import common
+from qiskit.transpiler.preset_passmanagers.plugin import (
+    PassManagerStagePluginManager,
+)
+
+
+def level_0_pass_manager(pass_manager_config: PassManagerConfig) -> StagedPassManager:
+    """Level 0 pass manager: no explicit optimization other than mapping to backend.
+
+    This pass manager applies the user-given initial layout. If none is given, a trivial
+    layout consisting of mapping the i-th virtual qubit to the i-th physical qubit is used.
+    Any unused physical qubit is allocated as ancilla space.
+
+    The pass manager then unrolls the circuit to the desired basis, and transforms the
+    circuit to match the coupling map.
+
+    Args:
+        pass_manager_config: configuration of the pass manager.
+
+    Returns:
+        a level 0 pass manager.
+
+    Raises:
+        TranspilerError: if the passmanager config is invalid.
+    """
+    plugin_manager = PassManagerStagePluginManager()
+    basis_gates = pass_manager_config.basis_gates
+    coupling_map = pass_manager_config.coupling_map
+    initial_layout = pass_manager_config.initial_layout
+    init_method = pass_manager_config.init_method or "default"
+    layout_method = pass_manager_config.layout_method or "default"
+    routing_method = pass_manager_config.routing_method or "sabre"
+    translation_method = pass_manager_config.translation_method or "translator"
+    optimization_method = pass_manager_config.optimization_method or "default"
+    scheduling_method = pass_manager_config.scheduling_method or "default"
+    target = pass_manager_config.target
+
+    # Choose routing pass
+    routing_pm = plugin_manager.get_passmanager_stage(
+        "routing", routing_method, pass_manager_config, optimization_level=0
+    )
+
+    # Build pass manager
+    if coupling_map or initial_layout:
+        layout = plugin_manager.get_passmanager_stage(
+            "layout", layout_method, pass_manager_config, optimization_level=0
+        )
+        routing = routing_pm
+    else:
+        layout = None
+        routing = None
+
+    translation = plugin_manager.get_passmanager_stage(
+        "translation", translation_method, pass_manager_config, optimization_level=0
+    )
+
+    if (coupling_map and not coupling_map.is_symmetric) or (
+        target is not None and target.get_non_global_operation_names(strict_direction=True)
+    ):
+        pre_opt = common.generate_pre_op_passmanager(target, coupling_map)
+        pre_opt += translation
+    else:
+        pre_opt = None
+
+    sched = plugin_manager.get_passmanager_stage(
+        "scheduling", scheduling_method, pass_manager_config, optimization_level=0
+    )
+
+    pre_init = common.generate_control_flow_options_check(
+        layout_method=layout_method,
+        routing_method=routing_method,
+        translation_method=translation_method,
+        optimization_method=optimization_method,
+        scheduling_method=scheduling_method,
+        basis_gates=basis_gates,
+        target=target,
+    )
+    init = plugin_manager.get_passmanager_stage(
+        "init", init_method, pass_manager_config, optimization_level=0
+    )
+    optimization = plugin_manager.get_passmanager_stage(
+        "optimization", optimization_method, pass_manager_config, optimization_level=0
+    )
+
+    return StagedPassManager(
+        pre_init=pre_init,
+        init=init,
+        layout=layout,
+        routing=routing,
+        translation=translation,
+        pre_optimization=pre_opt,
+        optimization=optimization,
+        scheduling=sched,
+    )

qiskit/transpiler/preset_passmanagers/level1.py

@@ -0,0 +1,120 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2018.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Pass manager for optimization level 1, providing light optimization.
+
+Level 1 pass manager: light optimization by simple adjacent gate collapsing.
+"""
+from __future__ import annotations
+from qiskit.transpiler.passmanager_config import PassManagerConfig
+from qiskit.transpiler.passmanager import StagedPassManager
+from qiskit.transpiler.preset_passmanagers import common
+from qiskit.transpiler.preset_passmanagers.plugin import (
+    PassManagerStagePluginManager,
+)
+
+
+def level_1_pass_manager(pass_manager_config: PassManagerConfig) -> StagedPassManager:
+    """Level 1 pass manager: light optimization by simple adjacent gate collapsing.
+
+    This pass manager applies the user-given initial layout. If none is given,
+    and a trivial layout (i-th virtual -> i-th physical) makes the circuit fit
+    the coupling map, that is used.
+    Otherwise, the circuit is mapped to the most densely connected coupling subgraph,
+    and swaps are inserted to map. Any unused physical qubit is allocated as ancilla space.
+    The pass manager then unrolls the circuit to the desired basis, and transforms the
+    circuit to match the coupling map. Finally, optimizations in the form of adjacent
+    gate collapse and redundant reset removal are performed.
+
+    Args:
+        pass_manager_config: configuration of the pass manager.
+
+    Returns:
+        a level 1 pass manager.
+
+    Raises:
+        TranspilerError: if the passmanager config is invalid.
+    """
+    plugin_manager = PassManagerStagePluginManager()
+    basis_gates = pass_manager_config.basis_gates
+    coupling_map = pass_manager_config.coupling_map
+    initial_layout = pass_manager_config.initial_layout
+    init_method = pass_manager_config.init_method or "default"
+    # Unlike other presets, the layout and routing defaults aren't set here because they change
+    # based on whether the input circuit has control flow.
+    layout_method = pass_manager_config.layout_method or "default"
+    routing_method = pass_manager_config.routing_method or "sabre"
+    translation_method = pass_manager_config.translation_method or "translator"
+    optimization_method = pass_manager_config.optimization_method or "default"
+    scheduling_method = pass_manager_config.scheduling_method or "default"
+    target = pass_manager_config.target
+
+    # Choose routing pass
+    routing_pm = plugin_manager.get_passmanager_stage(
+        "routing", routing_method, pass_manager_config, optimization_level=1
+    )
+
+    # Build full pass manager
+    if coupling_map or initial_layout:
+        layout = plugin_manager.get_passmanager_stage(
+            "layout", layout_method, pass_manager_config, optimization_level=1
+        )
+        routing = routing_pm
+
+    else:
+        layout = None
+        routing = None
+
+    translation = plugin_manager.get_passmanager_stage(
+        "translation", translation_method, pass_manager_config, optimization_level=1
+    )
+
+    if (coupling_map and not coupling_map.is_symmetric) or (
+        target is not None and target.get_non_global_operation_names(strict_direction=True)
+    ):
+        pre_optimization = common.generate_pre_op_passmanager(
+            target, coupling_map, remove_reset_in_zero=False
+        )
+    else:
+        pre_optimization = common.generate_pre_op_passmanager(remove_reset_in_zero=False)
+
+    optimization = plugin_manager.get_passmanager_stage(
+        "optimization", optimization_method, pass_manager_config, optimization_level=1
+    )
+
+    sched = plugin_manager.get_passmanager_stage(
+        "scheduling", scheduling_method, pass_manager_config, optimization_level=1
+    )
+
+    pre_init = common.generate_control_flow_options_check(
+        layout_method=layout_method,
+        routing_method=routing_method,
+        translation_method=translation_method,
+        optimization_method=optimization_method,
+        scheduling_method=scheduling_method,
+        basis_gates=basis_gates,
+        target=target,
+    )
+    init = plugin_manager.get_passmanager_stage(
+        "init", init_method, pass_manager_config, optimization_level=1
+    )
+
+    return StagedPassManager(
+        pre_init=pre_init,
+        init=init,
+        layout=layout,
+        routing=routing,
+        translation=translation,
+        pre_optimization=pre_optimization,
+        optimization=optimization,
+        scheduling=sched,
+    )

qiskit/transpiler/preset_passmanagers/level2.py

@@ -0,0 +1,119 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2018.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Pass manager for optimization level 2, providing medium optimization.
+
+Level 2 pass manager: medium optimization by noise adaptive qubit mapping and
+gate cancellation using commutativity rules.
+"""
+from __future__ import annotations
+from qiskit.transpiler.passmanager_config import PassManagerConfig
+from qiskit.transpiler.passmanager import StagedPassManager
+from qiskit.transpiler.preset_passmanagers import common
+from qiskit.transpiler.preset_passmanagers.plugin import (
+    PassManagerStagePluginManager,
+)
+
+
+def level_2_pass_manager(pass_manager_config: PassManagerConfig) -> StagedPassManager:
+    """Level 2 pass manager: medium optimization by initial layout selection and
+    gate cancellation using commutativity rules.
+
+    This pass manager applies the user-given initial layout. If none is given, a search
+    for a perfect layout (i.e. one that satisfies all 2-qubit interactions) is conducted.
+    If no such layout is found, qubits are laid out on the most densely connected subset
+    which also exhibits the best gate fidelities.
+
+    The pass manager then transforms the circuit to match the coupling constraints.
+    It is then unrolled to the basis, and any flipped cx directions are fixed.
+    Finally, optimizations in the form of commutative gate cancellation and redundant
+    reset removal are performed.
+
+    Args:
+        pass_manager_config: configuration of the pass manager.
+
+    Returns:
+        a level 2 pass manager.
+
+    Raises:
+        TranspilerError: if the passmanager config is invalid.
+    """
+    plugin_manager = PassManagerStagePluginManager()
+    basis_gates = pass_manager_config.basis_gates
+    coupling_map = pass_manager_config.coupling_map
+    initial_layout = pass_manager_config.initial_layout
+    init_method = pass_manager_config.init_method or "default"
+    layout_method = pass_manager_config.layout_method or "default"
+    routing_method = pass_manager_config.routing_method or "sabre"
+    translation_method = pass_manager_config.translation_method or "translator"
+    optimization_method = pass_manager_config.optimization_method or "default"
+    scheduling_method = pass_manager_config.scheduling_method or "default"
+    target = pass_manager_config.target
+
+    # Choose routing pass
+    routing_pm = plugin_manager.get_passmanager_stage(
+        "routing", routing_method, pass_manager_config, optimization_level=2
+    )
+
+    # Build pass manager
+    if coupling_map or initial_layout:
+        layout = plugin_manager.get_passmanager_stage(
+            "layout", layout_method, pass_manager_config, optimization_level=2
+        )
+        routing = routing_pm
+    else:
+        layout = None
+        routing = None
+    translation = plugin_manager.get_passmanager_stage(
+        "translation", translation_method, pass_manager_config, optimization_level=2
+    )
+
+    if (coupling_map and not coupling_map.is_symmetric) or (
+        target is not None and target.get_non_global_operation_names(strict_direction=True)
+    ):
+        pre_optimization = common.generate_pre_op_passmanager(
+            target, coupling_map, remove_reset_in_zero=False
+        )
+    else:
+        pre_optimization = common.generate_pre_op_passmanager(remove_reset_in_zero=False)
+
+    optimization = plugin_manager.get_passmanager_stage(
+        "optimization", optimization_method, pass_manager_config, optimization_level=2
+    )
+
+    sched = plugin_manager.get_passmanager_stage(
+        "scheduling", scheduling_method, pass_manager_config, optimization_level=2
+    )
+
+    pre_init = common.generate_control_flow_options_check(
+        layout_method=layout_method,
+        routing_method=routing_method,
+        translation_method=translation_method,
+        optimization_method=optimization_method,
+        scheduling_method=scheduling_method,
+        basis_gates=basis_gates,
+        target=target,
+    )
+    init = plugin_manager.get_passmanager_stage(
+        "init", init_method, pass_manager_config, optimization_level=2
+    )
+
+    return StagedPassManager(
+        pre_init=pre_init,
+        init=init,
+        layout=layout,
+        routing=routing,
+        translation=translation,
+        pre_optimization=pre_optimization,
+        optimization=optimization,
+        scheduling=sched,
+    )

qiskit/transpiler/preset_passmanagers/level3.py

@@ -0,0 +1,119 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2018.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Pass manager for optimization level 3, providing heavy optimization.
+
+Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and
+gate cancellation using commutativity rules and unitary synthesis.
+"""
+from __future__ import annotations
+from qiskit.transpiler.passmanager_config import PassManagerConfig
+from qiskit.transpiler.passmanager import StagedPassManager
+from qiskit.transpiler.preset_passmanagers import common
+from qiskit.transpiler.preset_passmanagers.plugin import (
+    PassManagerStagePluginManager,
+)
+
+
+def level_3_pass_manager(pass_manager_config: PassManagerConfig) -> StagedPassManager:
+    """Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and
+    gate cancellation using commutativity rules and unitary synthesis.
+
+    This pass manager applies the user-given initial layout. If none is given, a search
+    for a perfect layout (i.e. one that satisfies all 2-qubit interactions) is conducted.
+    If no such layout is found, and device calibration information is available, the
+    circuit is mapped to the qubits with best readouts and to CX gates with highest fidelity.
+
+    The pass manager then transforms the circuit to match the coupling constraints.
+    It is then unrolled to the basis, and any flipped cx directions are fixed.
+    Finally, optimizations in the form of commutative gate cancellation, resynthesis
+    of two-qubit unitary blocks, and redundant reset removal are performed.
+
+    Args:
+        pass_manager_config: configuration of the pass manager.
+
+    Returns:
+        a level 3 pass manager.
+
+    Raises:
+        TranspilerError: if the passmanager config is invalid.
+    """
+    plugin_manager = PassManagerStagePluginManager()
+    basis_gates = pass_manager_config.basis_gates
+    coupling_map = pass_manager_config.coupling_map
+    initial_layout = pass_manager_config.initial_layout
+    init_method = pass_manager_config.init_method or "default"
+    layout_method = pass_manager_config.layout_method or "default"
+    routing_method = pass_manager_config.routing_method or "sabre"
+    translation_method = pass_manager_config.translation_method or "translator"
+    scheduling_method = pass_manager_config.scheduling_method
+    optimization_method = pass_manager_config.optimization_method or "default"
+    scheduling_method = pass_manager_config.scheduling_method or "default"
+    target = pass_manager_config.target
+
+    # Choose routing pass
+    routing_pm = plugin_manager.get_passmanager_stage(
+        "routing", routing_method, pass_manager_config, optimization_level=3
+    )
+
+    # Build pass manager
+    pre_init = common.generate_control_flow_options_check(
+        layout_method=layout_method,
+        routing_method=routing_method,
+        translation_method=translation_method,
+        optimization_method=optimization_method,
+        scheduling_method=scheduling_method,
+        basis_gates=basis_gates,
+        target=target,
+    )
+    init = plugin_manager.get_passmanager_stage(
+        "init", init_method, pass_manager_config, optimization_level=3
+    )
+    if coupling_map or initial_layout:
+        layout = plugin_manager.get_passmanager_stage(
+            "layout", layout_method, pass_manager_config, optimization_level=3
+        )
+        routing = routing_pm
+    else:
+        layout = None
+        routing = None
+
+    translation = plugin_manager.get_passmanager_stage(
+        "translation", translation_method, pass_manager_config, optimization_level=3
+    )
+
+    optimization = plugin_manager.get_passmanager_stage(
+        "optimization", optimization_method, pass_manager_config, optimization_level=3
+    )
+    if (coupling_map and not coupling_map.is_symmetric) or (
+        target is not None and target.get_non_global_operation_names(strict_direction=True)
+    ):
+        pre_optimization = common.generate_pre_op_passmanager(
+            target, coupling_map, remove_reset_in_zero=False
+        )
+    else:
+        pre_optimization = common.generate_pre_op_passmanager(remove_reset_in_zero=False)
+
+    sched = plugin_manager.get_passmanager_stage(
+        "scheduling", scheduling_method, pass_manager_config, optimization_level=3
+    )
+
+    return StagedPassManager(
+        pre_init=pre_init,
+        init=init,
+        layout=layout,
+        routing=routing,
+        translation=translation,
+        pre_optimization=pre_optimization,
+        optimization=optimization,
+        scheduling=sched,
+    )