Source code for qiskit_aer.library.save_instructions.save_probabilities

# 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 measurement outcome probabilites.
"""

from qiskit.circuit import QuantumCircuit
from .save_data import SaveAverageData
from ..default_qubits import default_qubits


[docs]class SaveProbabilities(SaveAverageData): """Save measurement outcome probabilities vector.""" def __init__( self, num_qubits, label="probabilities", unnormalized=False, pershot=False, conditional=False, ): """Instruction to save measurement probabilities vector. Args: 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 probabilities over all shots [Default: False]. pershot (bool): if True save a list of probabilities for each shot of the simulation rather than the average over all shots [Default: False]. conditional (bool): if True save the probabilities data conditional on the current classical register values [Default: False]. """ super().__init__( "save_probabilities", num_qubits, label, conditional=conditional, pershot=pershot, unnormalized=unnormalized, )
[docs]class SaveProbabilitiesDict(SaveAverageData): """Save measurement outcome probabilities dict.""" def __init__( self, num_qubits, label="probabilities_dict", unnormalized=False, pershot=False, conditional=False, ): """Instruction to save measurement probabilities dict. Args: 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 probabilities over all shots [Default: False]. pershot (bool): if True save a list of probabilities for each shot of the simulation rather than the average over all shots [Default: False]. conditional (bool): if True save the probabilities data conditional on the current classical register values [Default: False]. """ super().__init__( "save_probabilities_dict", num_qubits, label, unnormalized=unnormalized, pershot=pershot, conditional=conditional, )
[docs]def save_probabilities( self, qubits=None, label="probabilities", unnormalized=False, pershot=False, conditional=False ): """Save measurement outcome probabilities vector. Args: qubits (list or None): the qubits to apply snapshot to. If None all qubits will be snapshot [Default: None]. 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 probabilities for each shot of the simulation rather than the average over all shots [Default: False]. conditional (bool): if True save the probabilities data conditional on the current classical register values [Default: False]. Returns: QuantumCircuit: with attached instruction. """ qubits = default_qubits(self, qubits=qubits) instr = SaveProbabilities( len(qubits), label=label, unnormalized=unnormalized, pershot=pershot, conditional=conditional, ) return self.append(instr, qubits)
[docs]def save_probabilities_dict( self, qubits=None, label="probabilities", unnormalized=False, pershot=False, conditional=False ): """Save measurement outcome probabilities vector. Args: qubits (list or None): the qubits to apply snapshot to. If None all qubits will be snapshot [Default: None]. 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 probabilities for each shot of the simulation rather than the average over all shots [Default: False]. conditional (bool): if True save the probabilities data conditional on the current classical register values [Default: False]. Returns: QuantumCircuit: with attached instruction. """ qubits = default_qubits(self, qubits=qubits) instr = SaveProbabilitiesDict( len(qubits), label=label, unnormalized=unnormalized, pershot=pershot, conditional=conditional, ) return self.append(instr, qubits)
QuantumCircuit.save_probabilities = save_probabilities QuantumCircuit.save_probabilities_dict = save_probabilities_dict