263 lines
13 KiB
Plaintext
263 lines
13 KiB
Plaintext
---
|
||
title: SaveStatevectorDict (v0.26)
|
||
description: API reference for qiskit.providers.aer.library.SaveStatevectorDict in qiskit v0.26
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.aer.library.SaveStatevectorDict
|
||
---
|
||
|
||
<span id="qiskit-providers-aer-library-savestatevectordict" />
|
||
|
||
# qiskit.providers.aer.library.SaveStatevectorDict
|
||
|
||
<Class id="qiskit.providers.aer.library.SaveStatevectorDict" isDedicatedPage={true} github="https://github.com/qiskit/qiskit-aer/tree/stable/0.8/qiskit/providers/aer/library/save_instructions/save_statevector.py" signature="SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)" modifiers="class">
|
||
Save statevector as ket-form dictionary.
|
||
|
||
Create new instruction to save the simulator statevector as a dict.
|
||
|
||
**Parameters**
|
||
|
||
* **num\_qubits** (*int*) – the number of qubits
|
||
* **label** (*str*) – the key for retrieving saved data from results.
|
||
* **pershot** (*bool*) – if True save a list of statevectors for each shot of the simulation rather than a single statevector \[Default: False].
|
||
* **conditional** (*bool*) – if True save data conditional on the current classical register values \[Default: False].
|
||
|
||
<Admonition title="Note" type="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.
|
||
</Admonition>
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.__init__" signature="__init__(num_qubits, label='statevector_dict', pershot=False, conditional=False)">
|
||
Create new instruction to save the simulator statevector as a dict.
|
||
|
||
**Parameters**
|
||
|
||
* **num\_qubits** (*int*) – the number of qubits
|
||
* **label** (*str*) – the key for retrieving saved data from results.
|
||
* **pershot** (*bool*) – if True save a list of statevectors for each shot of the simulation rather than a single statevector \[Default: False].
|
||
* **conditional** (*bool*) – if True save data conditional on the current classical register values \[Default: False].
|
||
|
||
<Admonition title="Note" type="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.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
||
| [`__init__`](#qiskit.providers.aer.library.SaveStatevectorDict.__init__ "qiskit.providers.aer.library.SaveStatevectorDict.__init__")(num\_qubits\[, label, pershot, …]) | Create new instruction to save the simulator statevector as a dict. |
|
||
| [`add_decomposition`](#qiskit.providers.aer.library.SaveStatevectorDict.add_decomposition "qiskit.providers.aer.library.SaveStatevectorDict.add_decomposition")(decomposition) | Add a decomposition of the instruction to the SessionEquivalenceLibrary. |
|
||
| [`assemble`](#qiskit.providers.aer.library.SaveStatevectorDict.assemble "qiskit.providers.aer.library.SaveStatevectorDict.assemble")() | Return the QasmQobjInstruction for the intructions. |
|
||
| [`broadcast_arguments`](#qiskit.providers.aer.library.SaveStatevectorDict.broadcast_arguments "qiskit.providers.aer.library.SaveStatevectorDict.broadcast_arguments")(qargs, cargs) | Validation of the arguments. |
|
||
| [`c_if`](#qiskit.providers.aer.library.SaveStatevectorDict.c_if "qiskit.providers.aer.library.SaveStatevectorDict.c_if")(classical, val) | Add classical condition on register classical and value val. |
|
||
| [`copy`](#qiskit.providers.aer.library.SaveStatevectorDict.copy "qiskit.providers.aer.library.SaveStatevectorDict.copy")(\[name]) | Copy of the instruction. |
|
||
| [`inverse`](#qiskit.providers.aer.library.SaveStatevectorDict.inverse "qiskit.providers.aer.library.SaveStatevectorDict.inverse")() | Special case. |
|
||
| [`is_parameterized`](#qiskit.providers.aer.library.SaveStatevectorDict.is_parameterized "qiskit.providers.aer.library.SaveStatevectorDict.is_parameterized")() | Return True .IFF. |
|
||
| [`mirror`](#qiskit.providers.aer.library.SaveStatevectorDict.mirror "qiskit.providers.aer.library.SaveStatevectorDict.mirror")() | DEPRECATED: use instruction.reverse\_ops(). |
|
||
| [`qasm`](#qiskit.providers.aer.library.SaveStatevectorDict.qasm "qiskit.providers.aer.library.SaveStatevectorDict.qasm")() | Return a default OpenQASM string for the instruction. |
|
||
| [`repeat`](#qiskit.providers.aer.library.SaveStatevectorDict.repeat "qiskit.providers.aer.library.SaveStatevectorDict.repeat")(n) | Creates an instruction with gate repeated n amount of times. |
|
||
| [`reverse_ops`](#qiskit.providers.aer.library.SaveStatevectorDict.reverse_ops "qiskit.providers.aer.library.SaveStatevectorDict.reverse_ops")() | For a composite instruction, reverse the order of sub-instructions. |
|
||
| [`soft_compare`](#qiskit.providers.aer.library.SaveStatevectorDict.soft_compare "qiskit.providers.aer.library.SaveStatevectorDict.soft_compare")(other) | Soft comparison between gates. |
|
||
| [`validate_parameter`](#qiskit.providers.aer.library.SaveStatevectorDict.validate_parameter "qiskit.providers.aer.library.SaveStatevectorDict.validate_parameter")(parameter) | Instruction parameters has no validation or normalization. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------- |
|
||
| [`decompositions`](#qiskit.providers.aer.library.SaveStatevectorDict.decompositions "qiskit.providers.aer.library.SaveStatevectorDict.decompositions") | Get the decompositions of the instruction from the SessionEquivalenceLibrary. |
|
||
| [`definition`](#qiskit.providers.aer.library.SaveStatevectorDict.definition "qiskit.providers.aer.library.SaveStatevectorDict.definition") | Return definition in terms of other basic gates. |
|
||
| [`duration`](#qiskit.providers.aer.library.SaveStatevectorDict.duration "qiskit.providers.aer.library.SaveStatevectorDict.duration") | Get the duration. |
|
||
| [`params`](#qiskit.providers.aer.library.SaveStatevectorDict.params "qiskit.providers.aer.library.SaveStatevectorDict.params") | return instruction params. |
|
||
| [`unit`](#qiskit.providers.aer.library.SaveStatevectorDict.unit "qiskit.providers.aer.library.SaveStatevectorDict.unit") | Get the time unit of duration. |
|
||
|
||
### add\_decomposition
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.add_decomposition" signature="add_decomposition(decomposition)">
|
||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||
</Function>
|
||
|
||
### assemble
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.assemble" signature="assemble()">
|
||
Return the QasmQobjInstruction for the intructions.
|
||
</Function>
|
||
|
||
### broadcast\_arguments
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.broadcast_arguments" signature="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>
|
||
|
||
### c\_if
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.c_if" signature="c_if(classical, val)">
|
||
Add classical condition on register classical and value val.
|
||
</Function>
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.copy" signature="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>
|
||
|
||
### decompositions
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveStatevectorDict.decompositions">
|
||
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
|
||
</Attribute>
|
||
|
||
### definition
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveStatevectorDict.definition">
|
||
Return definition in terms of other basic gates.
|
||
</Attribute>
|
||
|
||
### duration
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveStatevectorDict.duration">
|
||
Get the duration.
|
||
</Attribute>
|
||
|
||
### inverse
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.inverse" signature="inverse()">
|
||
Special case. Return self.
|
||
</Function>
|
||
|
||
### is\_parameterized
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.is_parameterized" signature="is_parameterized()">
|
||
Return True .IFF. instruction is parameterized else False
|
||
</Function>
|
||
|
||
### mirror
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.mirror" signature="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>
|
||
|
||
### params
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveStatevectorDict.params">
|
||
return instruction params.
|
||
</Attribute>
|
||
|
||
### qasm
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.qasm" signature="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>
|
||
|
||
### repeat
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.repeat" signature="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>
|
||
|
||
### reverse\_ops
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.reverse_ops" signature="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>
|
||
|
||
### soft\_compare
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.soft_compare" signature="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>
|
||
|
||
### unit
|
||
|
||
<Attribute id="qiskit.providers.aer.library.SaveStatevectorDict.unit">
|
||
Get the time unit of duration.
|
||
</Attribute>
|
||
|
||
### validate\_parameter
|
||
|
||
<Function id="qiskit.providers.aer.library.SaveStatevectorDict.validate_parameter" signature="validate_parameter(parameter)">
|
||
Instruction parameters has no validation or normalization.
|
||
</Function>
|
||
</Class>
|
||
|