scikit_quri.state package

Submodules

scikit_quri.state.overlap_estimator module

class scikit_quri.state.overlap_estimator.overlap_estimator(concurrent_sampler, n_shots=1000)

Bases: object

Alternative implementation of quri-parts’ overlap estimator.

Parameters:

• concurrent_sampler (Callable[[Iterable[tuple[quri_parts.rust.circuit.circuit.ImmutableQuantumCircuit, int]]], Iterable[Mapping[int, Union[int, float]]]]) –

• n_shots (int) –

create_overlap_circuit(ket_circuit, bra_circuit)

Create a circuit to compute the overlap between two quantum states. Operates non-destructively on the input circuits.

Parameters:

• ket_circuit (QuantumCircuit) – Quantum circuit representing the ket state.

• bra_circuit (QuantumCircuit) – Quantum circuit representing the bra state.

Returns:

A quantum circuit of the form U_ket U_bra†, whose |0⟩ measurement probability approximates |⟨ψ_ket|ψ_bra⟩|².

Return type:

QuantumCircuit

estimate(ket_circuit, bra_circuit)

Estimate the squared overlap |⟨ψ_ket|ψ_bra⟩|² between two quantum states. Operates non-destructively on the input circuits.

Parameters:

• ket_circuit (QuantumCircuit) – Quantum circuit representing the ket state.

• bra_circuit (QuantumCircuit) – Quantum circuit representing the bra state.

Returns:

Estimated value of |⟨ψ_ket|ψ_bra⟩|².

Return type:

float

estimate_concurrent(ket_circuits, bra_circuits)

Estimate |⟨ψ_i|ψ_j⟩|² for all combinations of ket and bra circuits.

Parameters:

• ket_circuits (list[quri_parts.rust.circuit.circuit.QuantumCircuit]) – List of quantum circuits representing ket states.

• bra_circuits (list[quri_parts.rust.circuit.circuit.QuantumCircuit]) – List of quantum circuits representing bra states.

Returns:

Flat array of shape (n_ket * n_bra,) containing the squared overlaps for all (ket, bra) pairs in row-major order.

Return type:

ndarray[tuple[int, …], dtype[float64]]

Module contents

class scikit_quri.state.overlap_estimator(concurrent_sampler, n_shots=1000)

Bases: object

Alternative implementation of quri-parts’ overlap estimator.

Parameters:

• concurrent_sampler (Callable[[Iterable[tuple[quri_parts.rust.circuit.circuit.ImmutableQuantumCircuit, int]]], Iterable[Mapping[int, Union[int, float]]]]) –

• n_shots (int) –

create_overlap_circuit(ket_circuit, bra_circuit)

Create a circuit to compute the overlap between two quantum states. Operates non-destructively on the input circuits.

Parameters:

• ket_circuit (QuantumCircuit) – Quantum circuit representing the ket state.

• bra_circuit (QuantumCircuit) – Quantum circuit representing the bra state.

Returns:

A quantum circuit of the form U_ket U_bra†, whose |0⟩ measurement probability approximates |⟨ψ_ket|ψ_bra⟩|².

Return type:

QuantumCircuit

estimate(ket_circuit, bra_circuit)

Estimate the squared overlap |⟨ψ_ket|ψ_bra⟩|² between two quantum states. Operates non-destructively on the input circuits.

Parameters:

• ket_circuit (QuantumCircuit) – Quantum circuit representing the ket state.

• bra_circuit (QuantumCircuit) – Quantum circuit representing the bra state.

Returns:

Estimated value of |⟨ψ_ket|ψ_bra⟩|².

Return type:

float

estimate_concurrent(ket_circuits, bra_circuits)

Estimate |⟨ψ_i|ψ_j⟩|² for all combinations of ket and bra circuits.

Parameters:

• ket_circuits (list[quri_parts.rust.circuit.circuit.QuantumCircuit]) – List of quantum circuits representing ket states.

• bra_circuits (list[quri_parts.rust.circuit.circuit.QuantumCircuit]) – List of quantum circuits representing bra states.

Returns:

Flat array of shape (n_ket * n_bra,) containing the squared overlaps for all (ket, bra) pairs in row-major order.

Return type:

ndarray[tuple[int, …], dtype[float64]]