qiskit-aer 0.17.2__cp314-cp314-win_amd64.whl

qiskit_aer/library/save_instructions/save_amplitudes.py

@@ -0,0 +1,168 @@
+# 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.
+"""
+Simulator instruction to save statevector amplitudes and amplitudes squared.
+"""
+
+from qiskit.circuit import QuantumCircuit
+from .save_data import SaveSingleData, SaveAverageData
+from ..default_qubits import default_qubits
+
+
+class SaveAmplitudes(SaveSingleData):
+    """Save complex statevector amplitudes."""
+
+    def __init__(self, num_qubits, params, label="amplitudes", pershot=False, conditional=False):
+        """Instruction to save complex statevector amplitudes.
+
+        Args:
+            num_qubits (int): the number of qubits for the snapshot type.
+            params (list): list of entries to vale.
+            label (str): the key for retrieving saved data from results.
+            pershot (bool): if True save a list of amplitudes vectors for each
+                            shot of the simulation rather than the a single
+                            amplitude vector [Default: False].
+            conditional (bool): if True save the amplitudes vector conditional
+                                on the current classical register values
+                                [Default: False].
+
+        Raises:
+            ValueError: if params is invalid for the specified number of qubits.
+        """
+        params = _format_amplitude_params(params, num_qubits)
+        super().__init__(
+            "save_amplitudes",
+            num_qubits,
+            label,
+            pershot=pershot,
+            conditional=conditional,
+            params=params,
+        )
+
+
+class SaveAmplitudesSquared(SaveAverageData):
+    """Save squared statevector amplitudes (probabilities)."""
+
+    def __init__(
+        self,
+        num_qubits,
+        params,
+        label="amplitudes_squared",
+        unnormalized=False,
+        pershot=False,
+        conditional=False,
+    ):
+        """Instruction to save squared statevector amplitudes (probabilities).
+
+        Args:
+            num_qubits (int): the number of qubits for the snapshot type.
+            params (list): list of entries to vale.
+            label (str): the key for retrieving saved data from results.
+            unnormalized (bool): If True return save the unnormalized accumulated
+                                 probabilities over all shots [Default: False].
+            pershot (bool): if True save a list of probability vectors for each
+                            shot of the simulation rather than the a single
+                            amplitude vector [Default: False].
+            conditional (bool): if True save the probability vector conditional
+                                on the current classical register values
+                                [Default: False].
+
+        Raises:
+            ValueError: if params is invalid for the specified number of qubits.
+        """
+        params = _format_amplitude_params(params, num_qubits)
+        super().__init__(
+            "save_amplitudes_sq",
+            num_qubits,
+            label,
+            unnormalized=unnormalized,
+            pershot=pershot,
+            conditional=conditional,
+            params=params,
+        )
+
+
+def save_amplitudes(self, params, label="amplitudes", pershot=False, conditional=False):
+    """Save complex statevector amplitudes.
+
+    Args:
+        params (List[int] or List[str]): the basis states to return amplitudes for.
+        label (str): the key for retrieving saved data from results.
+        pershot (bool): if True save a list of amplitudes vectors for each
+                        shot of the simulation rather than the a single
+                        amplitude vector [Default: False].
+        conditional (bool): if True save the amplitudes vector conditional
+                            on the current classical register values
+                            [Default: False].
+
+    Returns:
+        QuantumCircuit: with attached instruction.
+
+    Raises:
+        ValueError: if params is invalid for the specified number of qubits.
+    """
+    qubits = default_qubits(self)
+    instr = SaveAmplitudes(
+        len(qubits), params, label=label, pershot=pershot, conditional=conditional
+    )
+    return self.append(instr, qubits)
+
+
+def save_amplitudes_squared(
+    self, params, label="amplitudes_squared", unnormalized=False, pershot=False, conditional=False
+):
+    """Save squared statevector amplitudes (probabilities).
+
+    Args:
+        params (List[int] or List[str]): the basis states to return amplitudes for.
+        label (str): the key for retrieving saved data from results.
+        unnormalized (bool): If True return save the unnormalized accumulated
+                             probabilities over all shots [Default: False].
+        pershot (bool): if True save a list of probability vectors for each
+                        shot of the simulation rather than the a single
+                        amplitude vector [Default: False].
+        conditional (bool): if True save the probability vector conditional
+                            on the current classical register values
+                            [Default: False].
+
+    Returns:
+        QuantumCircuit: with attached instruction.
+
+    Raises:
+        ValueError: if params is invalid for the specified number of qubits.
+    """
+    qubits = default_qubits(self)
+    instr = SaveAmplitudesSquared(
+        len(qubits),
+        params,
+        label=label,
+        unnormalized=unnormalized,
+        pershot=pershot,
+        conditional=conditional,
+    )
+    return self.append(instr, qubits)
+
+
+def _format_amplitude_params(params, num_qubits=None):
+    """Format amplitude params as a interger list."""
+    if isinstance(params[0], str):
+        if params[0].find("0x") == 0:
+            params = [int(i, 16) for i in params]
+        else:
+            params = [int(i, 2) for i in params]
+    if num_qubits and max(params) >= 2**num_qubits:
+        raise ValueError("Param values contain a state larger than the number of qubits")
+    return params
+
+
+QuantumCircuit.save_amplitudes = save_amplitudes
+QuantumCircuit.save_amplitudes_squared = save_amplitudes_squared

qiskit_aer/library/save_instructions/save_clifford.py

@@ -0,0 +1,63 @@
+# 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.
+"""
+Simulator instruction to save Clifford state.
+"""
+
+from qiskit.circuit import QuantumCircuit
+from .save_data import SaveSingleData
+from ..default_qubits import default_qubits
+
+
+class SaveClifford(SaveSingleData):
+    """Save Clifford instruction"""
+
+    def __init__(self, num_qubits, label="clifford", pershot=False):
+        """Create new instruction to save the stabilizer simulator state as a Clifford.
+
+        Args:
+            num_qubits (int): the number of qubits of the
+            label (str): the key for retrieving saved data from results.
+            pershot (bool): if True save a list of Cliffords for each
+                            shot of the simulation rather than a single
+                            statevector [Default: False].
+
+        .. note::
+
+            This save instruction must always be performed on the full width of
+            qubits in a circuit, otherwise an exception will be raised during
+            simulation.
+        """
+        super().__init__("save_clifford", num_qubits, label, pershot=pershot)
+
+
+def save_clifford(self, label="clifford", pershot=False):
+    """Save the current stabilizer simulator quantum state as a Clifford.
+
+    Args:
+        label (str): the key for retrieving saved data from results.
+        pershot (bool): if True save a list of Cliffords for each
+                        shot of the simulation [Default: False].
+
+    Returns:
+        QuantumCircuit: with attached instruction.
+
+    .. note::
+
+        This instruction is always defined across all qubits in a circuit.
+    """
+    qubits = default_qubits(self)
+    instr = SaveClifford(len(qubits), label=label, pershot=pershot)
+    return self.append(instr, qubits)
+
+
+QuantumCircuit.save_clifford = save_clifford

qiskit_aer/library/save_instructions/save_data.py

@@ -0,0 +1,129 @@
+# 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.
+"""
+Simulator instruction to save custom internal data to results.
+"""
+
+import copy
+
+from qiskit.circuit import Instruction
+
+
+class SaveData(Instruction):
+    """Pragma Instruction to save simulator data."""
+
+    _directive = True
+    _allowed_subtypes = set(
+        ["single", "c_single", "list", "c_list", "average", "c_average", "accum", "c_accum"]
+    )
+
+    def __init__(self, name, num_qubits, label, subtype="single", params=None):
+        """Create new save data instruction.
+
+        Args:
+            name (str): the name of the save instruction.
+            num_qubits (int): the number of qubits for the snapshot type.
+            label (str): the key for retrieving saved data from results.
+            subtype (str): the data subtype for the instruction [Default: 'single'].
+            params (list or None): Optional, the parameters for instruction
+                                   [Default: None].
+
+        Raises:
+            TypeError: if the subtype string is invalid.
+
+        Additional Information:
+            The supported subtypes are 'single', 'list', 'c_list', 'average',
+            'c_average', 'accum', 'c_accum'.
+        """
+        if subtype not in self._allowed_subtypes:
+            raise TypeError("Invalid data subtype for SaveData instruction.")
+
+        if not isinstance(label, str):
+            raise TypeError(f"Invalid label for save data instruction, {label} must be a string.")
+
+        if params is None:
+            params = {}
+
+        super().__init__(name, num_qubits, 0, params)
+
+        self._label = label
+        self._subtype = subtype
+
+    def inverse(self, annotated=False):
+        """Special case. Return self."""
+        return copy.copy(self)
+
+
+class SaveAverageData(SaveData):
+    """Save averageble data"""
+
+    def __init__(
+        self,
+        name,
+        num_qubits,
+        label,
+        unnormalized=False,
+        pershot=False,
+        conditional=False,
+        params=None,
+    ):
+        """Create new save data instruction.
+
+        Args:
+            name (str): the name of the save instruction.
+            num_qubits (int): the number of qubits for the snapshot type.
+            label (str): the key for retrieving saved data from results.
+            unnormalized (bool): If True return save the unnormalized accumulated
+                                 or conditional accumulated data over all shot.
+                                 [Default: False].
+            pershot (bool): if True save a list of data for each shot of the
+                            simulation rather than the average over  all shots
+                            [Default: False].
+            conditional (bool): if True save the average or pershot data
+                                conditional on the current classical register
+                                values [Default: False].
+            params (list or None): Optional, the parameters for instruction
+                                   [Default: None].
+        """
+        if pershot:
+            subtype = "list"
+        elif unnormalized:
+            subtype = "accum"
+        else:
+            subtype = "average"
+        if conditional:
+            subtype = "c_" + subtype
+        super().__init__(name, num_qubits, label, subtype=subtype, params=params)
+
+
+class SaveSingleData(SaveData):
+    """Save non-averagable single data type."""
+
+    def __init__(self, name, num_qubits, label, pershot=False, conditional=False, params=None):
+        """Create new save data instruction.
+
+        Args:
+            name (str): the name of the save instruction.
+            num_qubits (int): the number of qubits for the snapshot type.
+            label (str): the key for retrieving saved data from results.
+            pershot (bool): if True save a list of data for each shot of the
+                            simulation [Default: False].
+            conditional (bool): if True save data conditional on the
+                                current classical register values
+                                [Default: False].
+            params (list or None): Optional, the parameters for instruction
+                                   [Default: None].
+        """
+        subtype = "list" if pershot else "single"
+        if conditional:
+            subtype = "c_" + subtype
+        super().__init__(name, num_qubits, label, subtype=subtype, params=params)

qiskit_aer/library/save_instructions/save_density_matrix.py

@@ -0,0 +1,91 @@
+# 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.
+"""
+Simulator instruction to save a density matrix.
+"""
+
+from qiskit.circuit import QuantumCircuit
+from .save_data import SaveAverageData
+from ..default_qubits import default_qubits
+
+
+class SaveDensityMatrix(SaveAverageData):
+    """Save a reduced density matrix."""
+
+    def __init__(
+        self,
+        num_qubits,
+        label="density_matrix",
+        unnormalized=False,
+        pershot=False,
+        conditional=False,
+    ):
+        """Create new instruction to save the simulator reduced density matrix.
+
+        Args:
+            num_qubits (int): the number of qubits for the save instruction.
+            label (str): the key for retrieving saved data from results.
+            unnormalized (bool): If True return save the unnormalized accumulated
+                                 or conditional accumulated density matrix over
+                                 all shots [Default: False].
+            pershot (bool): if True save a list of density matrices for each shot
+                            of the  simulation rather than the average over
+                            all shots [Default: False].
+            conditional (bool): if True save the average or pershot data
+                                conditional on the current classical register
+                                values [Default: False].
+        """
+        super().__init__(
+            "save_density_matrix",
+            num_qubits,
+            label,
+            unnormalized=unnormalized,
+            pershot=pershot,
+            conditional=conditional,
+        )
+
+
+def save_density_matrix(
+    self, qubits=None, label="density_matrix", unnormalized=False, pershot=False, conditional=False
+):
+    """Save the current simulator quantum state as a density matrix.
+
+    Args:
+        qubits (list or None): the qubits to save reduced density matrix on.
+                               If None the full density matrix of qubits will
+                               be saved [Default: None].
+        label (str): the key for retrieving saved data from results.
+        unnormalized (bool): If True return save the unnormalized accumulated
+                             or conditional accumulated density matrix over
+                             all shots [Default: False].
+        pershot (bool): if True save a list of density matrices for each shot
+                        of the  simulation rather than the average over
+                        all shots [Default: False].
+        conditional (bool): if True save the average or pershot data
+                            conditional on the current classical register
+                            values [Default: False].
+
+    Returns:
+        QuantumCircuit: with attached instruction.
+    """
+    qubits = default_qubits(self, qubits=qubits)
+    instr = SaveDensityMatrix(
+        len(qubits),
+        label=label,
+        unnormalized=unnormalized,
+        pershot=pershot,
+        conditional=conditional,
+    )
+    return self.append(instr, qubits)
+
+
+QuantumCircuit.save_density_matrix = save_density_matrix