qiskit-aer 0.17.2__cp314-cp314-win_amd64.whl

qiskit_aer/backends/compatibility.py

@@ -0,0 +1,287 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2018, 2021.
+#
+# 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.
+"""
+Compatibility classes for changes to save instruction return types.
+
+These subclasses include a `__getattr__` method that allows existing
+code which used numpy.ndarray attributes to continue functioning with
+a deprecation warning.
+
+Numpy functions that consumed these classes should already work due to
+them having an `__array__` method for implicit array conversion.
+"""
+
+import warnings
+import numpy as np
+import qiskit.quantum_info as qi
+
+
+def _forward_attr(attr):
+    """Return True if attribute should be passed to legacy class"""
+    # Pass Iterable magic methods on to the Numpy array.  We can't pass
+    # `__getitem__` (and consequently `__setitem__`, `__delitem__`) on because
+    # `Statevector` implements them itself.
+    if attr[:2] == "__" or attr in ["_data", "_op_shape"]:
+        return False
+    return True
+
+
+def _deprecation_warning(instance, instances_name):
+    class_name = instance.__class__.__name__
+    warnings.warn(
+        f"The return type of saved {instances_name} has been changed from"
+        f" a `numpy.ndarray` to a `qiskit.quantum_info.{class_name}` as"
+        " of qiskit-aer 0.10. Accessing numpy array attributes is deprecated"
+        " and will result in an error in a future release. To continue using"
+        " saved result objects as arrays you can explicitly cast them using "
+        " `np.asarray(object)`.",
+        DeprecationWarning,
+        stacklevel=3,
+    )
+
+
+class Statevector(qi.Statevector):
+    """Aer result backwards compatibility wrapper for qiskit Statevector."""
+
+    def __getattr__(self, attr):
+        if _forward_attr(attr) and hasattr(self._data, attr):
+            _deprecation_warning(self, "statevectors")
+            return getattr(self._data, attr)
+        return getattr(super(), attr)
+
+    def __eq__(self, other):
+        return (
+            isinstance(self, type(other))
+            and self._op_shape == other._op_shape
+            and np.allclose(self.data, other.data, rtol=self.rtol, atol=self.atol)
+        )
+
+    def __bool__(self):
+        # Explicit override to the default behaviour for Python objects to
+        # prevent the new `__len__` from messing with it.
+        return True
+
+    # Magic methods for the iterable/collection interface that need forwarding,
+    # but bypass `__getattr__`.  `__getitem__` is defined by `Statevector`, so
+    # that can't be forwarded (and consequently neither can `__setitem__`
+    # without introducing an inconsistency).
+
+    def __len__(self):
+        _deprecation_warning(self, "statevectors")
+        return self._data.__len__()
+
+    def __iter__(self):
+        _deprecation_warning(self, "statevectors")
+        return self._data.__iter__()
+
+    def __contains__(self, value):
+        _deprecation_warning(self, "statevectors")
+        return self._data.__contains__(value)
+
+    def __reversed__(self):
+        _deprecation_warning(self, "statevectors")
+        return self._data.__reversed__()
+
+
+class DensityMatrix(qi.DensityMatrix):
+    """Aer result backwards compatibility wrapper for qiskit DensityMatrix."""
+
+    def __getattr__(self, attr):
+        if _forward_attr(attr) and hasattr(self._data, attr):
+            _deprecation_warning(self, "density matrices")
+            return getattr(self._data, attr)
+        return getattr(super(), attr)
+
+    def __eq__(self, other):
+        return (
+            isinstance(self, type(other))
+            and self._op_shape == other._op_shape
+            and np.allclose(self.data, other.data, rtol=self.rtol, atol=self.atol)
+        )
+
+    def __len__(self):
+        _deprecation_warning(self, "density matrices")
+        return self._data.__len__()
+
+    def __iter__(self):
+        _deprecation_warning(self, "density matrices")
+        return self._data.__iter__()
+
+    def __contains__(self, value):
+        _deprecation_warning(self, "density matrices")
+        return self._data.__contains__(value)
+
+    def __reversed__(self):
+        _deprecation_warning(self, "density matrices")
+        return self._data.__reversed__()
+
+    def __getitem__(self, key):
+        _deprecation_warning(self, "density matrices")
+        return self._data.__getitem__(key)
+
+    def __setitem__(self, key, value):
+        _deprecation_warning(self, "density matrices")
+        return self._data.__setitem__(key, value)
+
+
+class Operator(qi.Operator):
+    """Aer result backwards compatibility wrapper for qiskit Operator."""
+
+    def __getattr__(self, attr):
+        if _forward_attr(attr) and hasattr(self._data, attr):
+            _deprecation_warning(self, "unitaries")
+            return getattr(self._data, attr)
+        return getattr(super(), attr)
+
+    def __eq__(self, other):
+        return (
+            isinstance(self, type(other))
+            and self._op_shape == other._op_shape
+            and np.allclose(self.data, other.data, rtol=self.rtol, atol=self.atol)
+        )
+
+    def __bool__(self):
+        # Explicit override to the default behaviour for Python objects to
+        # prevent the new `__len__` from messing with it.
+        return True
+
+    def __len__(self):
+        _deprecation_warning(self, "unitaries")
+        return self._data.__len__()
+
+    def __iter__(self):
+        _deprecation_warning(self, "unitaries")
+        return self._data.__iter__()
+
+    def __contains__(self, value):
+        _deprecation_warning(self, "unitaries")
+        return self._data.__contains__(value)
+
+    def __reversed__(self):
+        _deprecation_warning(self, "unitaries")
+        return self._data.__reversed__()
+
+    def __getitem__(self, key):
+        _deprecation_warning(self, "unitaries")
+        return self._data.__getitem__(key)
+
+    def __setitem__(self, key, value):
+        _deprecation_warning(self, "unitaries")
+        return self._data.__setitem__(key, value)
+
+
+class SuperOp(qi.SuperOp):
+    """Aer result backwards compatibility wrapper for qiskit SuperOp."""
+
+    def __getattr__(self, attr):
+        if _forward_attr(attr) and hasattr(self._data, attr):
+            _deprecation_warning(self, "superoperators")
+            return getattr(self._data, attr)
+        return getattr(super(), attr)
+
+    def __eq__(self, other):
+        return (
+            isinstance(self, type(other))
+            and self._op_shape == other._op_shape
+            and np.allclose(self.data, other.data, rtol=self.rtol, atol=self.atol)
+        )
+
+    def __bool__(self):
+        # Explicit override to the default behaviour for Python objects to
+        # prevent the new `__len__` from messing with it.
+        return True
+
+    def __len__(self):
+        _deprecation_warning(self, "superoperators")
+        return self._data.__len__()
+
+    def __iter__(self):
+        _deprecation_warning(self, "superoperators")
+        return self._data.__iter__()
+
+    def __contains__(self, value):
+        _deprecation_warning(self, "superoperators")
+        return self._data.__contains__(value)
+
+    def __reversed__(self):
+        _deprecation_warning(self, "superoperators")
+        return self._data.__reversed__()
+
+    def __getitem__(self, key):
+        _deprecation_warning(self, "superoperators")
+        return self._data.__getitem__(key)
+
+    def __setitem__(self, key, value):
+        _deprecation_warning(self, "superoperators")
+        return self._data.__setitem__(key, value)
+
+
+class StabilizerState(qi.StabilizerState):
+    """Aer result backwards compatibility wrapper for qiskit StabilizerState."""
+
+    def __deprecation_warning(self):
+        warnings.warn(
+            "The return type of saved stabilizers has been changed from"
+            " a `dict` to a `qiskit.quantum_info.StabilizerState` as of qiskit-aer 0.10."
+            " Accessing dict attributes is deprecated and will result in an"
+            " error in a future release. Use the `.clifford.to_dict()` methods to access "
+            " the stored Clifford operator and convert to a dictionary.",
+            DeprecationWarning,
+            stacklevel=3,
+        )
+
+    def __getattr__(self, attr):
+        if _forward_attr(attr) and hasattr(dict, attr):
+            self.__deprecation_warning()
+            return getattr(self._data.to_dict(), attr)
+        return getattr(super(), attr)
+
+    def __getitem__(self, item):
+        if item in ["stabilizer", "destabilizer"]:
+            warnings.warn(
+                "The return type of saved stabilizers has been changed from"
+                " a `dict` to a `qiskit.quantum_info.StabilizerState` as of qiskit-aer 0.10."
+                " Accessing dict items is deprecated and will result in an"
+                " error in a future release. Use the `.clifford.to_dict()` methods to access "
+                " the stored Clifford operator and convert to a dictionary.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            return self._data.to_dict()[item]
+        raise TypeError("'StabilizerState object is not subscriptable'")
+
+    def __bool__(self):
+        # Explicit override to the default behaviour for Python objects to
+        # prevent the new `__len__` from messing with it.
+        return True
+
+    def __len__(self):
+        self.__deprecation_warning()
+        return self._data.to_dict().__len__()
+
+    def __iter__(self):
+        self.__deprecation_warning()
+        return self._data.to_dict().__iter__()
+
+    def __contains__(self, value):
+        self.__deprecation_warning()
+        return self._data.to_dict().__contains__(value)
+
+    def __reversed__(self):
+        self.__deprecation_warning()
+        return self._data.to_dict().__reversed__()
+
+    def _add(self, other):
+        raise NotImplementedError(f"{type(self)} does not support addition")
+
+    def _multiply(self, other):
+        raise NotImplementedError(f"{type(self)} does not support scalar multiplication")

qiskit_aer/backends/name_mapping.py

@@ -0,0 +1,306 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2018, 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.
+
+# pylint: disable=invalid-name
+"""
+Qiskit Aer simulator name mapping for Target object
+"""
+from qiskit.circuit import ControlledGate, Parameter
+from qiskit.circuit.reset import Reset
+from qiskit.circuit.store import Store
+from qiskit.circuit.library import (
+    U2Gate,
+    RGate,
+    CYGate,
+    CZGate,
+    CSXGate,
+    CU3Gate,
+    CSwapGate,
+    PauliGate,
+    DiagonalGate,
+    UnitaryGate,
+    MCPhaseGate,
+    MCXGate,
+    CRXGate,
+    CRYGate,
+    CRZGate,
+    MCU1Gate,
+    MCXGrayCode,
+    Initialize,
+    UCGate,
+)
+from qiskit.circuit.controlflow import (
+    IfElseOp,
+    WhileLoopOp,
+    ForLoopOp,
+    ContinueLoopOp,
+    BreakLoopOp,
+    SwitchCaseOp,
+)
+from qiskit.quantum_info.operators.channel.kraus import Kraus
+from qiskit.quantum_info.operators.channel import SuperOp
+from qiskit.quantum_info.operators.channel.quantum_channel import QuantumChannel
+
+from ..library import (
+    SaveExpectationValue,
+    SaveAmplitudes,
+    SaveStatevectorDict,
+    SaveSuperOp,
+    SaveClifford,
+    SaveMatrixProductState,
+    SaveDensityMatrix,
+    SaveProbabilities,
+    SaveStatevector,
+    SetDensityMatrix,
+    SetUnitary,
+    SaveState,
+    SetMatrixProductState,
+    SaveUnitary,
+    SetSuperOp,
+    SaveExpectationValueVariance,
+    SaveStabilizer,
+    SetStatevector,
+    SetStabilizer,
+    SaveAmplitudesSquared,
+    SaveProbabilitiesDict,
+)
+from ..noise.errors import ReadoutError
+from ..noise.noise_model import QuantumErrorLocation
+
+
+class MCSXGate(ControlledGate):
+    """mcsx gate"""
+
+    def __init__(self, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcsx",
+            1 + num_ctrl_qubits,
+            [],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=CSXGate(),
+        )
+
+
+class MCYGate(ControlledGate):
+    """mcy gate"""
+
+    def __init__(self, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcy",
+            1 + num_ctrl_qubits,
+            [],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=CYGate(),
+        )
+
+
+class MCZGate(ControlledGate):
+    """mcz gate"""
+
+    def __init__(self, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcz",
+            1 + num_ctrl_qubits,
+            [],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=CZGate(),
+        )
+
+
+class MCRXGate(ControlledGate):
+    """mcrx gate"""
+
+    def __init__(self, theta, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcrx",
+            1 + num_ctrl_qubits,
+            [theta],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=CRXGate(theta),
+        )
+
+
+class MCRYGate(ControlledGate):
+    """mcry gate"""
+
+    def __init__(self, theta, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcry",
+            1 + num_ctrl_qubits,
+            [theta],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=CRYGate(theta),
+        )
+
+
+class MCRZGate(ControlledGate):
+    """mcrz gate"""
+
+    def __init__(self, theta, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcrz",
+            1 + num_ctrl_qubits,
+            [theta],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=CRZGate(theta),
+        )
+
+
+class MCRGate(ControlledGate):
+    """mcr gate"""
+
+    def __init__(self, theta, phi, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcr",
+            1 + num_ctrl_qubits,
+            [theta, phi],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=RGate(theta, phi),
+        )
+
+
+class MCU2Gate(ControlledGate):
+    """mcu2 gate"""
+
+    def __init__(self, theta, lam, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcu2",
+            1 + num_ctrl_qubits,
+            [theta, lam],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=U2Gate(theta, lam),
+        )
+
+
+class MCU3Gate(ControlledGate):
+    """mcu3 gate"""
+
+    def __init__(self, theta, lam, phi, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcu3",
+            1 + num_ctrl_qubits,
+            [theta, phi, lam],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=CU3Gate(theta, phi, lam),
+        )
+
+
+class MCUGate(ControlledGate):
+    """mcu gate"""
+
+    def __init__(self, theta, lam, phi, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcu",
+            1 + num_ctrl_qubits,
+            [theta, phi, lam],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=CU3Gate(theta, phi, lam),
+        )
+
+
+class MCSwapGate(ControlledGate):
+    """mcswap gate"""
+
+    def __init__(self, num_ctrl_qubits, ctrl_state=None):
+        super().__init__(
+            "mcswap",
+            2 + num_ctrl_qubits,
+            [],
+            None,
+            num_ctrl_qubits,
+            ctrl_state=ctrl_state,
+            base_gate=CSwapGate(),
+        )
+
+
+PHI = Parameter("phi")
+LAM = Parameter("lam")
+NAME_MAPPING = {
+    "cu2": U2Gate(PHI, LAM).control(),
+    "pauli": PauliGate,
+    "diagonal": DiagonalGate,
+    "unitary": UnitaryGate,
+    "mcsx": MCSXGate,
+    "mcp": MCPhaseGate,
+    "mcphase": MCPhaseGate,
+    "mcu": MCUGate,
+    "mcu1": MCU1Gate,
+    "mcu2": MCU2Gate,
+    "mcu3": MCU3Gate,
+    "mcx": MCXGate,
+    "mcy": MCYGate,
+    "mcz": MCZGate,
+    "mcr": MCRGate,
+    "mcrx": MCRXGate,
+    "mcry": MCRYGate,
+    "mcrz": MCRZGate,
+    "mcx_gray": MCXGrayCode,
+    "mcswap": MCSwapGate,
+    "multiplexer": UCGate,
+    "kraus": Kraus,
+    "superop": SuperOp,
+    "initialize": Initialize,
+    "quantum_channel": QuantumChannel,
+    "save_expval": SaveExpectationValue,
+    "save_amplitudes": SaveAmplitudes,
+    "roerror": ReadoutError,
+    "save_statevector_dict": SaveStatevectorDict,
+    "save_superop": SaveSuperOp,
+    "save_clifford": SaveClifford,
+    "save_matrix_product_state": SaveMatrixProductState,
+    "save_density_matrix": SaveDensityMatrix,
+    "save_probabilities": SaveProbabilities,
+    "if_else": IfElseOp,
+    "while_loop": WhileLoopOp,
+    "for_loop": ForLoopOp,
+    "switch_case": SwitchCaseOp,
+    "break_loop": BreakLoopOp,
+    "continue_loop": ContinueLoopOp,
+    "save_statevector": SaveStatevector,
+    "set_density_matrix": SetDensityMatrix,
+    "qerror_loc": QuantumErrorLocation,
+    "set_unitary": SetUnitary,
+    "save_state": SaveState,
+    "set_matrix_product_state": SetMatrixProductState,
+    "save_unitary": SaveUnitary,
+    "set_superop": SetSuperOp,
+    "save_expval_var": SaveExpectationValueVariance,
+    "save_stabilizer": SaveStabilizer,
+    "set_statevector": SetStatevector,
+    "set_stabilizer": SetStabilizer,
+    "save_amplitudes_sq": SaveAmplitudesSquared,
+    "save_probabilities_dict": SaveProbabilitiesDict,
+    "save_probs_ket": SaveProbabilitiesDict,
+    "save_probs": SaveProbabilities,
+    "reset": Reset(),
+    "store": Store,
+}