Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

SnapshotStatevector

SnapshotStatevector(label, num_qubits=0)

GitHub(opens in a new tab)

Bases: qiskit.providers.aer.extensions.snapshot.Snapshot

Snapshot instruction for statevector snapshot type

Create a statevector state snapshot instruction.

Parameters

  • label (str) – the snapshot label.
  • num_qubits (int) – the instruction barrier size [Default: 0].

Raises

ExtensionError – if snapshot is invalid.

Additional Information:

This snapshot is always performed on all qubits in a circuit. The number of qubits parameter specifies the size of the instruction as a barrier and should be set to the number of qubits in the circuit.

Deprecated since version 0.9.0

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.SaveStatevector instruction.


Methods

add_decomposition

SnapshotStatevector.add_decomposition(decomposition)

Add a decomposition of the instruction to the SessionEquivalenceLibrary.

assemble

SnapshotStatevector.assemble()

Assemble a QasmQobjInstruction

broadcast_arguments

SnapshotStatevector.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

SnapshotStatevector.c_if(classical, val)

Set a classical equality condition on this instruction between the register or cbit classical and value val.

Note

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

SnapshotStatevector.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

define_snapshot_register

static SnapshotStatevector.define_snapshot_register(circuit, label=None, qubits=None)

Defines qubits to snapshot for all snapshot methods

inverse

SnapshotStatevector.inverse()

Special case. Return self.

is_parameterized

SnapshotStatevector.is_parameterized()

Return True .IFF. instruction is parameterized else False

qasm

SnapshotStatevector.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

SnapshotStatevector.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

Raises

CircuitError – If n < 1.

reverse_ops

SnapshotStatevector.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

soft_compare

SnapshotStatevector.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

SnapshotStatevector.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

name

Return the name.

num_clbits

Return the number of clbits.

num_qubits

Return the number of qubits.

params

return instruction params.

snapshot_type

Return snapshot type

unit

Get the time unit of duration.

Was this page helpful?
Report a bug or request content on GitHub.