qiskit 1.3.0b1__cp39-abi3-macosx_10_9_x86_64.whl

qiskit/transpiler/passes/__init__.py

@@ -0,0 +1,310 @@
+# 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.
+
+"""
+===================================================
+Transpiler Passes (:mod:`qiskit.transpiler.passes`)
+===================================================
+
+.. currentmodule:: qiskit.transpiler.passes
+
+Layout Selection (Placement)
+============================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   SetLayout
+   TrivialLayout
+   DenseLayout
+   SabreLayout
+   CSPLayout
+   VF2Layout
+   ApplyLayout
+   Layout2qDistance
+   EnlargeWithAncilla
+   FullAncillaAllocation
+   SabrePreLayout
+
+Routing
+=======
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   BasicSwap
+   LookaheadSwap
+   StochasticSwap
+   SabreSwap
+   Commuting2qGateRouter
+   StarPreRouting
+
+Basis Change
+============
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   BasisTranslator
+   Decompose
+   TranslateParameterizedGates
+   Unroll3qOrMore
+   UnrollCustomDefinitions
+
+Optimizations
+=============
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   Optimize1qGates
+   Optimize1qGatesDecomposition
+   Collect1qRuns
+   Collect2qBlocks
+   CollectMultiQBlocks
+   CollectAndCollapse
+   CollectLinearFunctions
+   CollectCliffords
+   ConsolidateBlocks
+   CXCancellation
+   InverseCancellation
+   CommutationAnalysis
+   CommutativeCancellation
+   CommutativeInverseCancellation
+   Optimize1qGatesSimpleCommutation
+   RemoveDiagonalGatesBeforeMeasure
+   RemoveResetInZeroState
+   RemoveFinalReset
+   HoareOptimizer
+   TemplateOptimization
+   EchoRZXWeylDecomposition
+   ResetAfterMeasureSimplification
+   OptimizeCliffords
+   ElidePermutations
+   NormalizeRXAngle
+   OptimizeAnnotated
+   Split2QUnitaries
+
+Calibration
+=============
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   PulseGates
+   RZXCalibrationBuilder
+   RZXCalibrationBuilderNoEcho
+   RXCalibrationBuilder
+
+.. autofunction:: rzx_templates
+
+Scheduling
+=============
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   TimeUnitConversion
+   ALAPScheduleAnalysis
+   ASAPScheduleAnalysis
+   PadDynamicalDecoupling
+   PadDelay
+   ConstrainedReschedule
+   ValidatePulseGates
+   InstructionDurationCheck
+   SetIOLatency
+   ALAPSchedule
+   ASAPSchedule
+   DynamicalDecoupling
+   AlignMeasures
+
+Circuit Analysis
+================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   Width
+   Depth
+   Size
+   CountOps
+   CountOpsLongestPath
+   NumTensorFactors
+   DAGLongestPath
+
+Synthesis
+=========
+
+The synthesis transpiler plugin documentation can be found in the
+:mod:`qiskit.transpiler.passes.synthesis.plugin` page.
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   UnitarySynthesis
+   LinearFunctionsToPermutations
+   HighLevelSynthesis
+   HLSConfig
+   SolovayKitaev
+
+Post Layout
+===========
+
+These are post qubit selection.
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   VF2PostLayout
+
+Additional Passes
+=================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   CheckMap
+   CheckGateDirection
+   GateDirection
+   MergeAdjacentBarriers
+   RemoveBarriers
+   BarrierBeforeFinalMeasurements
+   RemoveFinalMeasurements
+   DAGFixedPoint
+   FixedPoint
+   MinimumPoint
+   ContainsInstruction
+   GatesInBasis
+   ConvertConditionsToIfOps
+   UnrollForLoops
+   FilterOpNodes
+"""
+
+# layout selection (placement)
+from .layout import SetLayout
+from .layout import TrivialLayout
+from .layout import DenseLayout
+from .layout import SabreLayout
+from .layout import CSPLayout
+from .layout import VF2Layout
+from .layout import VF2PostLayout
+from .layout import ApplyLayout
+from .layout import Layout2qDistance
+from .layout import EnlargeWithAncilla
+from .layout import FullAncillaAllocation
+from .layout import SabrePreLayout
+
+# routing
+from .routing import BasicSwap
+from .routing import LayoutTransformation
+from .routing import LookaheadSwap
+from .routing import StochasticSwap
+from .routing import SabreSwap
+from .routing import Commuting2qGateRouter
+from .routing import StarPreRouting
+
+# basis change
+from .basis import Decompose
+from .basis import UnrollCustomDefinitions
+from .basis import Unroll3qOrMore
+from .basis import BasisTranslator
+from .basis import TranslateParameterizedGates
+
+# optimization
+from .optimization import Optimize1qGates
+from .optimization import Optimize1qGatesDecomposition
+from .optimization import Collect2qBlocks
+from .optimization import Collect1qRuns
+from .optimization import CollectMultiQBlocks
+from .optimization import ConsolidateBlocks
+from .optimization import CommutationAnalysis
+from .optimization import CommutativeCancellation
+from .optimization import CommutativeInverseCancellation
+from .optimization import CXCancellation
+from .optimization import Optimize1qGatesSimpleCommutation
+from .optimization import OptimizeSwapBeforeMeasure
+from .optimization import RemoveResetInZeroState
+from .optimization import RemoveFinalReset
+from .optimization import RemoveDiagonalGatesBeforeMeasure
+from .optimization import HoareOptimizer
+from .optimization import TemplateOptimization
+from .optimization import InverseCancellation
+from .optimization import EchoRZXWeylDecomposition
+from .optimization import CollectAndCollapse
+from .optimization import CollectLinearFunctions
+from .optimization import CollectCliffords
+from .optimization import ResetAfterMeasureSimplification
+from .optimization import OptimizeCliffords
+from .optimization import ElidePermutations
+from .optimization import NormalizeRXAngle
+from .optimization import OptimizeAnnotated
+from .optimization import Split2QUnitaries
+
+# circuit analysis
+from .analysis import ResourceEstimation
+from .analysis import Depth
+from .analysis import Size
+from .analysis import Width
+from .analysis import CountOps
+from .analysis import CountOpsLongestPath
+from .analysis import NumTensorFactors
+from .analysis import DAGLongestPath
+
+# synthesis
+from .synthesis import UnitarySynthesis
+from .synthesis import unitary_synthesis_plugin_names
+from .synthesis import LinearFunctionsToPermutations
+from .synthesis import HighLevelSynthesis
+from .synthesis import HLSConfig
+from .synthesis import SolovayKitaev
+from .synthesis import SolovayKitaevSynthesis
+from .synthesis import AQCSynthesisPlugin
+
+# calibration
+from .calibration import PulseGates
+from .calibration import RZXCalibrationBuilder
+from .calibration import RZXCalibrationBuilderNoEcho
+from .calibration import RXCalibrationBuilder
+from .calibration.rzx_templates import rzx_templates
+
+# circuit scheduling
+from .scheduling import TimeUnitConversion
+from .scheduling import ALAPScheduleAnalysis
+from .scheduling import ASAPScheduleAnalysis
+from .scheduling import PadDynamicalDecoupling
+from .scheduling import ValidatePulseGates
+from .scheduling import PadDelay
+from .scheduling import ConstrainedReschedule
+from .scheduling import InstructionDurationCheck
+from .scheduling import SetIOLatency
+from .scheduling import ALAPSchedule
+from .scheduling import ASAPSchedule
+from .scheduling import DynamicalDecoupling
+from .scheduling import AlignMeasures
+
+# additional utility passes
+from .utils import CheckMap
+from .utils import CheckGateDirection
+from .utils import GateDirection
+from .utils import BarrierBeforeFinalMeasurements
+from .utils import RemoveFinalMeasurements
+from .utils import MergeAdjacentBarriers
+from .utils import DAGFixedPoint
+from .utils import FixedPoint
+from .utils import MinimumPoint
+from .utils import Error
+from .utils import RemoveBarriers
+from .utils import ContainsInstruction
+from .utils import GatesInBasis
+from .utils import ConvertConditionsToIfOps
+from .utils import UnrollForLoops
+from .utils import FilterOpNodes

qiskit/transpiler/passes/analysis/__init__.py

@@ -0,0 +1,23 @@
+# 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.
+
+"""Module containing circuit analysis passes."""
+
+from .resource_estimation import ResourceEstimation
+from .depth import Depth
+from .width import Width
+from .size import Size
+from .count_ops import CountOps
+from .count_ops_longest_path import CountOpsLongestPath
+from .num_tensor_factors import NumTensorFactors
+from .num_qubits import NumQubits
+from .dag_longest_path import DAGLongestPath

qiskit/transpiler/passes/analysis/count_ops.py

@@ -0,0 +1,30 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019.
+#
+# 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.
+
+"""Count the operations in a DAG circuit."""
+
+from qiskit.transpiler.basepasses import AnalysisPass
+
+
+class CountOps(AnalysisPass):
+    """Count the operations in a DAG circuit.
+
+    The result is saved in ``property_set['count_ops']`` as an integer.
+    """
+
+    def __init__(self, *, recurse=True):
+        super().__init__()
+        self.recurse = recurse
+
+    def run(self, dag):
+        """Run the CountOps pass on `dag`."""
+        self.property_set["count_ops"] = dag.count_ops(recurse=self.recurse)

qiskit/transpiler/passes/analysis/count_ops_longest_path.py

@@ -0,0 +1,26 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019.
+#
+# 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.
+
+"""Count the operations on the longest path in a DAGCircuit."""
+
+from qiskit.transpiler.basepasses import AnalysisPass
+
+
+class CountOpsLongestPath(AnalysisPass):
+    """Count the operations on the longest path in a :class:`.DAGCircuit`.
+
+    The result is saved in ``property_set['count_ops_longest_path']`` as an integer.
+    """
+
+    def run(self, dag):
+        """Run the CountOpsLongestPath pass on `dag`."""
+        self.property_set["count_ops_longest_path"] = dag.count_ops_longest_path()

qiskit/transpiler/passes/analysis/dag_longest_path.py

@@ -0,0 +1,24 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019.
+#
+# 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.
+
+"""Return the longest path in a :class:`.DAGCircuit` as a list of DAGNodes."""
+
+from qiskit.transpiler.basepasses import AnalysisPass
+
+
+class DAGLongestPath(AnalysisPass):
+    """Return the longest path in a :class:`.DAGCircuit` as a list of
+    :class:`.DAGOpNode`\\ s, :class:`.DAGInNode`\\ s, and :class:`.DAGOutNode`\\ s."""
+
+    def run(self, dag):
+        """Run the DAGLongestPath pass on `dag`."""
+        self.property_set["dag_longest_path"] = dag.longest_path()

qiskit/transpiler/passes/analysis/depth.py

@@ -0,0 +1,33 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019.
+#
+# 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.
+
+"""Calculate the depth of a DAG circuit."""
+
+from qiskit.transpiler.basepasses import AnalysisPass
+
+
+class Depth(AnalysisPass):
+    """Calculate the depth of a DAG circuit."""
+
+    def __init__(self, *, recurse=False):
+        """
+        Args:
+            recurse: whether to allow recursion into control flow.  If this is ``False`` (default),
+                the pass will throw an error when control flow is present, to avoid returning a
+                number with little meaning.
+        """
+        super().__init__()
+        self.recurse = recurse
+
+    def run(self, dag):
+        """Run the Depth pass on `dag`."""
+        self.property_set["depth"] = dag.depth(recurse=self.recurse)

qiskit/transpiler/passes/analysis/num_qubits.py

@@ -0,0 +1,26 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019.
+#
+# 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.
+
+"""Calculate the number of qubits of a DAG circuit."""
+
+from qiskit.transpiler.basepasses import AnalysisPass
+
+
+class NumQubits(AnalysisPass):
+    """Calculate the number of qubits of a DAG circuit.
+
+    The result is saved in ``property_set['num_qubits']`` as an integer.
+    """
+
+    def run(self, dag):
+        """Run the NumQubits pass on `dag`."""
+        self.property_set["num_qubits"] = dag.num_qubits()

qiskit/transpiler/passes/analysis/num_tensor_factors.py

@@ -0,0 +1,26 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019.
+#
+# 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.
+
+"""Calculate the number of tensor factors of a DAG circuit."""
+
+from qiskit.transpiler.basepasses import AnalysisPass
+
+
+class NumTensorFactors(AnalysisPass):
+    """Calculate the number of tensor factors of a DAG circuit.
+
+    The result is saved in ``property_set['num_tensor_factors']`` as an integer.
+    """
+
+    def run(self, dag):
+        """Run the NumTensorFactors pass on `dag`."""
+        self.property_set["num_tensor_factors"] = dag.num_tensor_factors()

qiskit/transpiler/passes/analysis/resource_estimation.py

@@ -0,0 +1,41 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019.
+#
+# 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.
+
+"""Automatically require analysis passes for resource estimation."""
+
+from qiskit.transpiler.basepasses import AnalysisPass
+from qiskit.transpiler.passes.analysis.depth import Depth
+from qiskit.transpiler.passes.analysis.width import Width
+from qiskit.transpiler.passes.analysis.size import Size
+from qiskit.transpiler.passes.analysis.count_ops import CountOps
+from qiskit.transpiler.passes.analysis.num_tensor_factors import NumTensorFactors
+from qiskit.transpiler.passes.analysis.num_qubits import NumQubits
+
+
+class ResourceEstimation(AnalysisPass):
+    """Automatically require analysis passes for resource estimation.
+
+    An analysis pass for automatically running:
+    * Depth()
+    * Width()
+    * Size()
+    * CountOps()
+    * NumTensorFactors()
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.requires += [Depth(), Width(), Size(), CountOps(), NumTensorFactors(), NumQubits()]
+
+    def run(self, _):
+        """Run the ResourceEstimation pass on `dag`."""
+        pass

qiskit/transpiler/passes/analysis/size.py

@@ -0,0 +1,36 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019.
+#
+# 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.
+
+"""Calculate the size of a DAG circuit."""
+
+from qiskit.transpiler.basepasses import AnalysisPass
+
+
+class Size(AnalysisPass):
+    """Calculate the size of a DAG circuit.
+
+    The result is saved in ``property_set['size']`` as an integer.
+    """
+
+    def __init__(self, *, recurse=False):
+        """
+        Args:
+            recurse: whether to allow recursion into control flow.  If this is ``False`` (default),
+                the pass will throw an error when control flow is present, to avoid returning a
+                number with little meaning.
+        """
+        super().__init__()
+        self.recurse = recurse
+
+    def run(self, dag):
+        """Run the Size pass on `dag`."""
+        self.property_set["size"] = dag.size(recurse=self.recurse)

qiskit/transpiler/passes/analysis/width.py

@@ -0,0 +1,27 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2019.
+#
+# 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.
+
+"""Calculate the width of a DAG circuit."""
+
+from qiskit.transpiler.basepasses import AnalysisPass
+
+
+class Width(AnalysisPass):
+    """Calculate the width of a DAG circuit.
+
+    The result is saved in ``property_set['width']`` as an integer that
+    contains the number of qubits + the number of clbits.
+    """
+
+    def run(self, dag):
+        """Run the Width pass on `dag`."""
+        self.property_set["width"] = dag.width()

qiskit/transpiler/passes/basis/__init__.py

@@ -0,0 +1,19 @@
+# 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.
+
+"""Module containing basis change passes."""
+
+from .decompose import Decompose
+from .unroll_custom_definitions import UnrollCustomDefinitions
+from .unroll_3q_or_more import Unroll3qOrMore
+from .basis_translator import BasisTranslator
+from .translate_parameterized import TranslateParameterizedGates