SnapshotProbabilities
SnapshotProbabilities(label, num_qubits, variance=False) GitHub(opens in a new tab)
Bases: qiskit.providers.aer.extensions.snapshot.Snapshot
Snapshot instruction for all methods of Qasm simulator.
Create a probability snapshot instruction.
Parameters
- label (str) – the snapshot label.
- num_qubits (int) – the number of qubits to snapshot.
- variance (bool) – compute variance of probabilities [Default: False]
Raises
ExtensionError – if snapshot is invalid.
This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the qiskit.providers.aer.library.SaveProbabilities and qiskit.providers.aer.library.SaveProbabilitiesDict instructions.
Methods
add_decomposition
SnapshotProbabilities.add_decomposition(decomposition)
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
assemble
SnapshotProbabilities.assemble()
Assemble a QasmQobjInstruction
broadcast_arguments
SnapshotProbabilities.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
SnapshotProbabilities.c_if(classical, val)
Set a classical equality condition on this instruction between the register or cbit classical and value val.
This is a setter method, not an additive one. Calling this multiple times will silently override any previously set condition; it does not stack.
copy
SnapshotProbabilities.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
define_snapshot_register
static SnapshotProbabilities.define_snapshot_register(circuit, label=None, qubits=None)
Defines qubits to snapshot for all snapshot methods
inverse
SnapshotProbabilities.inverse()
Special case. Return self.
is_parameterized
SnapshotProbabilities.is_parameterized()
Return True .IFF. instruction is parameterized else False
mirror
SnapshotProbabilities.mirror()
DEPRECATED: use instruction.reverse_ops().
Returns
a new instruction with sub-instructions
reversed.
Return type
qasm
SnapshotProbabilities.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
SnapshotProbabilities.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
SnapshotProbabilities.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
soft_compare
SnapshotProbabilities.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
validate_parameter
SnapshotProbabilities.validate_parameter(parameter)
Instruction parameters has no validation or normalization.
Attributes
condition_bits
Get Clbits in condition.
Return type
List[Clbit]
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.