254 lines
8.1 KiB
Plaintext
254 lines
8.1 KiB
Plaintext
---
|
||
title: SaveProbabilitiesDict (v0.31)
|
||
description: API reference for qiskit.providers.aer.library.SaveProbabilitiesDict in qiskit v0.31
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict
|
||
---
|
||
|
||
# SaveProbabilitiesDict
|
||
|
||
<Class id="qiskit.providers.aer.library.SaveProbabilitiesDict" isDedicatedPage={true} github="https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py" signature="SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)" modifiers="class">
|
||
Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData`
|
||
|
||
Save measurement outcome probabilities dict.
|
||
|
||
Instruction to save measurement probabilities dict.
|
||
|
||
**Parameters**
|
||
|
||
* **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].
|
||
|
||
## Methods
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-add-decomposition" />
|
||
|
||
### add\_decomposition
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.add_decomposition" signature="SaveProbabilitiesDict.add_decomposition(decomposition)">
|
||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-assemble" />
|
||
|
||
### assemble
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.assemble" signature="SaveProbabilitiesDict.assemble()">
|
||
Return the QasmQobjInstruction for the intructions.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-broadcast-arguments" />
|
||
|
||
### broadcast\_arguments
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.broadcast_arguments" signature="SaveProbabilitiesDict.broadcast_arguments(qargs, cargs)">
|
||
Validation of the arguments.
|
||
|
||
**Parameters**
|
||
|
||
* **qargs** (*List*) – List of quantum bit arguments.
|
||
* **cargs** (*List*) – List of classical bit arguments.
|
||
|
||
**Yields**
|
||
|
||
*Tuple(List, List)* – A tuple with single arguments.
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-c-if" />
|
||
|
||
### c\_if
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.c_if" signature="SaveProbabilitiesDict.c_if(classical, val)">
|
||
Add classical condition on register or cbit classical and value val.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-copy" />
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.copy" signature="SaveProbabilitiesDict.copy(name=None)">
|
||
Copy of the instruction.
|
||
|
||
**Parameters**
|
||
|
||
**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same.
|
||
|
||
**Returns**
|
||
|
||
**a copy of the current instruction, with the name**
|
||
|
||
updated if it was provided
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-inverse" />
|
||
|
||
### inverse
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.inverse" signature="SaveProbabilitiesDict.inverse()">
|
||
Special case. Return self.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-is-parameterized" />
|
||
|
||
### is\_parameterized
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.is_parameterized" signature="SaveProbabilitiesDict.is_parameterized()">
|
||
Return True .IFF. instruction is parameterized else False
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-mirror" />
|
||
|
||
### mirror
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.mirror" signature="SaveProbabilitiesDict.mirror()">
|
||
DEPRECATED: use instruction.reverse\_ops().
|
||
|
||
**Returns**
|
||
|
||
**a new instruction with sub-instructions**
|
||
|
||
reversed.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-qasm" />
|
||
|
||
### qasm
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.qasm" signature="SaveProbabilitiesDict.qasm()">
|
||
Return a default OpenQASM string for the instruction.
|
||
|
||
Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];).
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-repeat" />
|
||
|
||
### repeat
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.repeat" signature="SaveProbabilitiesDict.repeat(n)">
|
||
Creates an instruction with gate repeated n amount of times.
|
||
|
||
**Parameters**
|
||
|
||
**n** (*int*) – Number of times to repeat the instruction
|
||
|
||
**Returns**
|
||
|
||
Containing the definition.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – If n \< 1.
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-reverse-ops" />
|
||
|
||
### reverse\_ops
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.reverse_ops" signature="SaveProbabilitiesDict.reverse_ops()">
|
||
For a composite instruction, reverse the order of sub-instructions.
|
||
|
||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||
|
||
**Returns**
|
||
|
||
**a new instruction with**
|
||
|
||
sub-instructions reversed.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-soft-compare" />
|
||
|
||
### soft\_compare
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.soft_compare" signature="SaveProbabilitiesDict.soft_compare(other)">
|
||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||
|
||
**Parameters**
|
||
|
||
**other** (*instruction*) – other instruction.
|
||
|
||
**Returns**
|
||
|
||
are self and other equal up to parameter expressions.
|
||
|
||
**Return type**
|
||
|
||
bool
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-aer-library-saveprobabilitiesdict-validate-parameter" />
|
||
|
||
### validate\_parameter
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveProbabilitiesDict.validate_parameter" signature="SaveProbabilitiesDict.validate_parameter(parameter)">
|
||
Instruction parameters has no validation or normalization.
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### decompositions
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveProbabilitiesDict.decompositions">
|
||
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
|
||
</Attribute>
|
||
|
||
### definition
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveProbabilitiesDict.definition">
|
||
Return definition in terms of other basic gates.
|
||
</Attribute>
|
||
|
||
### duration
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveProbabilitiesDict.duration">
|
||
Get the duration.
|
||
</Attribute>
|
||
|
||
### label
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveProbabilitiesDict.label">
|
||
Return instruction label
|
||
|
||
**Return type**
|
||
|
||
`str`
|
||
</Attribute>
|
||
|
||
### params
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveProbabilitiesDict.params">
|
||
return instruction params.
|
||
</Attribute>
|
||
|
||
### unit
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveProbabilitiesDict.unit">
|
||
Get the time unit of duration.
|
||
</Attribute>
|
||
</Class>
|
||
|