Skip to main contentIBM Quantum Documentation
Important

IBM Quantum Platform is moving and this version will be sunset on July 1. To get started on the new platform, read the migration guide.

CircuitState

class CircuitState

GitHub

Bases: State

An MPO-like representation of a time-evolution state based on quantum circuits.

This time-evolution state can be evolved on its left- and right-hand side as required by the DynamicMPF algorithm.

Initialize a CircuitState instance.


Attributes

lhs

Type: Circuit | None

The left-hand side circuit in form of a tensor network.

rhs

Type: Circuit | None

The right-hand side circuit in form of a tensor network.


Methods

overlap

overlap(initial_state)

GitHub

Compute the overlap of this state with the provided initial state.

Warning

This implementation only supports instances of qiskit.circuit.QuantumCircuit for initial_state.

Parameters

initial_state (Any) – the initial state with which to compute the overlap.

Raises

TypeError – if the provided initial state has an incompatible type.

Returns

The overlap of this state with the provided one.

Return type

complex

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