BaseStateFidelity
class qiskit.algorithms.state_fidelities.BaseStateFidelity
Bases: ABC
An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. The calculation depends on the particular fidelity method implementation, but can be always defined as the state overlap:
where and are optional parametrizations of the states and prepared by the circuits circuit_1 and circuit_2, respectively.
Methods
create_fidelity_circuit
abstract create_fidelity_circuit(circuit_1, circuit_2)
Implementation-dependent method to create a fidelity circuit from 2 circuit inputs.
Parameters
- circuit_1 (QuantumCircuit) – (Parametrized) quantum circuit.
- circuit_2 (QuantumCircuit) – (Parametrized) quantum circuit.
Returns
The fidelity quantum circuit corresponding to circuit_1 and circuit_2.
Return type
run
run(circuits_1, circuits_2, values_1=None, values_2=None, **options)
Runs asynchronously the state overlap (fidelity) calculation between two (parametrized) circuits (first and second) for a specific set of parameter values (first and second). This calculation depends on the particular fidelity method implementation.
Parameters
- circuits_1 (QuantumCircuit | Sequence[QuantumCircuit]) – (Parametrized) quantum circuits preparing .
- circuits_2 (QuantumCircuit | Sequence[QuantumCircuit]) – (Parametrized) quantum circuits preparing .
- values_1 (Sequence[float] | Sequence[Sequence[float]] | None) – Numerical parameters to be bound to the first set of circuits.
- values_2 (Sequence[float] | Sequence[Sequence[float]] | None) – Numerical parameters to be bound to the second set of circuits.
- options – Primitive backend runtime options used for circuit execution. The order of priority is: options in
runmethod > fidelity’s default options > primitive’s default setting. Higher priority setting overrides lower priority setting.
Returns
Primitive job for the fidelity calculation. The job’s result is an instance of StateFidelityResult.
Return type