qiskit.providers.aer.extensions.Snapshot
class Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)
Simulator snapshot instruction.
Create new snapshot instruction.
Parameters
- label (str) – the snapshot label for result data.
- snapshot_type (str) – the type of the snapshot.
- num_qubits (int) – the number of qubits for the snapshot type [Default: 0].
- num_clbits (int) – the number of classical bits for the snapshot type [Default: 0].
- params (list or None) – the parameters for snapshot_type [Default: None].
Raises
ExtensionError – if snapshot label is invalid.
__init__
__init__(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)
Create new snapshot instruction.
Parameters
- label (str) – the snapshot label for result data.
- snapshot_type (str) – the type of the snapshot.
- num_qubits (int) – the number of qubits for the snapshot type [Default: 0].
- num_clbits (int) – the number of classical bits for the snapshot type [Default: 0].
- params (list or None) – the parameters for snapshot_type [Default: None].
Raises
ExtensionError – if snapshot label is invalid.
Methods
__init__(label[, snapshot_type, num_qubits, …]) | Create new snapshot instruction. |
add_decomposition(decomposition) | Add a decomposition of the instruction to the SessionEquivalenceLibrary. |
assemble() | Assemble a QasmQobjInstruction |
broadcast_arguments(qargs, cargs) | Validation of the arguments. |
c_if(classical, val) | Add classical condition on register classical and value val. |
copy([name]) | Copy of the instruction. |
define_snapshot_register(circuit[, label, …]) | Defines qubits to snapshot for all snapshot methods |
inverse() | Special case. |
is_parameterized() | Return True .IFF. |
mirror() | DEPRECATED: use instruction.reverse_ops(). |
qasm() | Return a default OpenQASM string for the instruction. |
repeat(n) | Creates an instruction with gate repeated n amount of times. |
reverse_ops() | For a composite instruction, reverse the order of sub-instructions. |
validate_parameter(parameter) | Instruction parameters has no validation or normalization. |
Attributes
decompositions | Get the decompositions of the instruction from the SessionEquivalenceLibrary. |
definition | Return definition in terms of other basic gates. |
duration | Get the duration. |
label | Return snapshot label |
params | return instruction params. |
snapshot_type | Return snapshot type |
unit | Get the time unit of duration. |
add_decomposition
add_decomposition(decomposition)
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
assemble
assemble()
Assemble a QasmQobjInstruction
broadcast_arguments
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.
c_if
c_if(classical, val)
Add classical condition on register classical and value val.
copy
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
decompositions
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
define_snapshot_register
static define_snapshot_register(circuit, label=None, qubits=None)
Defines qubits to snapshot for all snapshot methods
definition
Return definition in terms of other basic gates.
duration
Get the duration.
inverse
inverse()
Special case. Return self.
is_parameterized
is_parameterized()
Return True .IFF. instruction is parameterized else False
label
Return snapshot label
mirror
mirror()
DEPRECATED: use instruction.reverse_ops().
Returns
a new instruction with sub-instructions
reversed.
Return type
params
return instruction params.
qasm
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];).
repeat
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
Raises
CircuitError – If n < 1.
reverse_ops
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
snapshot_type
Return snapshot type
unit
Get the time unit of duration.
validate_parameter
validate_parameter(parameter)
Instruction parameters has no validation or normalization.