qiskit 2.1.0rc1__cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

qiskit/primitives/statevector_sampler.py

@@ -0,0 +1,290 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2023, 2024.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+"""
+Statevector Sampler V2 class
+"""
+
+from __future__ import annotations
+
+import warnings
+from dataclasses import dataclass
+from typing import Iterable
+
+import numpy as np
+from numpy.typing import NDArray
+
+from qiskit import ClassicalRegister, QiskitError, QuantumCircuit
+from qiskit.quantum_info import Statevector
+
+from .base import BaseSamplerV2
+from .base.validation_v1 import _has_measure
+from .containers import (
+    BitArray,
+    DataBin,
+    PrimitiveResult,
+    SamplerPubResult,
+    SamplerPubLike,
+)
+from .containers.sampler_pub import SamplerPub
+from .containers.bit_array import _min_num_bytes
+from .primitive_job import PrimitiveJob
+from .utils import bound_circuit_to_instruction
+
+
+@dataclass
+class _MeasureInfo:
+    creg_name: str
+    num_bits: int
+    num_bytes: int
+    qreg_indices: list[int]
+
+
+class StatevectorSampler(BaseSamplerV2):
+    """
+    Simple implementation of :class:`BaseSamplerV2` using full state vector simulation.
+
+    This class is implemented via :class:`~.Statevector` which turns provided circuits into
+    pure state vectors, and is therefore incompatible with mid-circuit measurements (although
+    other implementations may be).
+
+    As seen in the example below, this sampler supports providing arrays of parameter value sets to
+    bind against a single circuit.
+
+    Each tuple of ``(circuit, <optional> parameter values, <optional> shots)``, called a sampler
+    primitive unified bloc (PUB), produces its own array-valued result. The :meth:`~run` method can
+    be given many pubs at once.
+
+    .. plot::
+       :include-source:
+       :nofigs:
+
+        from qiskit.circuit import (
+            Parameter, QuantumCircuit, ClassicalRegister, QuantumRegister
+        )
+        from qiskit.primitives import StatevectorSampler
+
+        import matplotlib.pyplot as plt
+        import numpy as np
+
+        # Define our circuit registers, including classical registers
+        # called 'alpha' and 'beta'.
+        qreg = QuantumRegister(3)
+        alpha = ClassicalRegister(2, "alpha")
+        beta = ClassicalRegister(1, "beta")
+
+        # Define a quantum circuit with two parameters.
+        circuit = QuantumCircuit(qreg, alpha, beta)
+        circuit.h(0)
+        circuit.cx(0, 1)
+        circuit.cx(1, 2)
+        circuit.ry(Parameter("a"), 0)
+        circuit.rz(Parameter("b"), 0)
+        circuit.cx(1, 2)
+        circuit.cx(0, 1)
+        circuit.h(0)
+        circuit.measure([0, 1], alpha)
+        circuit.measure([2], beta)
+
+        # Define a sweep over parameter values, where the second axis is over.
+        # the two parameters in the circuit.
+        params = np.vstack([
+            np.linspace(-np.pi, np.pi, 100),
+            np.linspace(-4 * np.pi, 4 * np.pi, 100)
+        ]).T
+
+        # Instantiate a new statevector simulation based sampler object.
+        sampler = StatevectorSampler()
+
+        # Start a job that will return shots for all 100 parameter value sets.
+        pub = (circuit, params)
+        job = sampler.run([pub], shots=256)
+
+        # Extract the result for the 0th pub (this example only has one pub).
+        result = job.result()[0]
+
+        # There is one BitArray object for each ClassicalRegister in the
+        # circuit. Here, we can see that the BitArray for alpha contains data
+        # for all 100 sweep points, and that it is indeed storing data for 2
+        # bits over 256 shots.
+        assert result.data.alpha.shape == (100,)
+        assert result.data.alpha.num_bits == 2
+        assert result.data.alpha.num_shots == 256
+
+        # We can work directly with a binary array in performant applications.
+        raw = result.data.alpha.array
+
+        # For small registers where it is anticipated to have many counts
+        # associated with the same bitstrings, we can turn the data from,
+        # for example, the 22nd sweep index into a dictionary of counts.
+        counts = result.data.alpha.get_counts(22)
+
+        # Or, convert into a list of bitstrings that preserve shot order.
+        bitstrings = result.data.alpha.get_bitstrings(22)
+        print(bitstrings)
+
+    """
+
+    def __init__(self, *, default_shots: int = 1024, seed: np.random.Generator | int | None = None):
+        """
+        Args:
+            default_shots: The default shots for the sampler if not specified during run.
+            seed: The seed or Generator object for random number generation.
+                If None, a random seeded default RNG will be used.
+        """
+        self._default_shots = default_shots
+        self._seed = seed
+
+    @property
+    def default_shots(self) -> int:
+        """Return the default shots"""
+        return self._default_shots
+
+    @property
+    def seed(self) -> np.random.Generator | int | None:
+        """Return the seed or Generator object for random number generation."""
+        return self._seed
+
+    def run(
+        self, pubs: Iterable[SamplerPubLike], *, shots: int | None = None
+    ) -> PrimitiveJob[PrimitiveResult[SamplerPubResult]]:
+        if shots is None:
+            shots = self._default_shots
+        coerced_pubs = [SamplerPub.coerce(pub, shots) for pub in pubs]
+        if any(len(pub.circuit.cregs) == 0 for pub in coerced_pubs):
+            warnings.warn(
+                "One of your circuits has no output classical registers and so the result "
+                "will be empty. Did you mean to add measurement instructions?",
+                UserWarning,
+            )
+
+        job = PrimitiveJob(self._run, coerced_pubs)
+        job._submit()
+        return job
+
+    def _run(self, pubs: Iterable[SamplerPub]) -> PrimitiveResult[SamplerPubResult]:
+        results = [self._run_pub(pub) for pub in pubs]
+        return PrimitiveResult(results, metadata={"version": 2})
+
+    def _run_pub(self, pub: SamplerPub) -> SamplerPubResult:
+        circuit, qargs, meas_info = _preprocess_circuit(pub.circuit)
+        bound_circuits = pub.parameter_values.bind_all(circuit)
+        arrays = {
+            item.creg_name: np.zeros(
+                bound_circuits.shape + (pub.shots, item.num_bytes), dtype=np.uint8
+            )
+            for item in meas_info
+        }
+        for index, bound_circuit in np.ndenumerate(bound_circuits):
+            final_state = Statevector(bound_circuit_to_instruction(bound_circuit))
+            final_state.seed(self._seed)
+            if qargs:
+                samples = final_state.sample_memory(shots=pub.shots, qargs=qargs)
+            else:
+                samples = [""] * pub.shots
+            samples_array = np.array([np.fromiter(sample, dtype=np.uint8) for sample in samples])
+            for item in meas_info:
+                ary = _samples_to_packed_array(samples_array, item.num_bits, item.qreg_indices)
+                arrays[item.creg_name][index] = ary
+
+        meas = {
+            item.creg_name: BitArray(arrays[item.creg_name], item.num_bits) for item in meas_info
+        }
+        return SamplerPubResult(
+            DataBin(**meas, shape=pub.shape),
+            metadata={"shots": pub.shots, "circuit_metadata": pub.circuit.metadata},
+        )
+
+
+def _preprocess_circuit(circuit: QuantumCircuit):
+    num_bits_dict = {creg.name: creg.size for creg in circuit.cregs}
+    mapping = _final_measurement_mapping(circuit)
+    qargs = sorted(set(mapping.values()))
+    qargs_index = {v: k for k, v in enumerate(qargs)}
+    circuit = circuit.remove_final_measurements(inplace=False)
+    if _has_control_flow(circuit):
+        raise QiskitError("StatevectorSampler cannot handle ControlFlowOp")
+    if _has_measure(circuit):
+        raise QiskitError("StatevectorSampler cannot handle mid-circuit measurements")
+    # num_qubits is used as sentinel to fill 0 in _samples_to_packed_array
+    sentinel = len(qargs)
+    indices = {key: [sentinel] * val for key, val in num_bits_dict.items()}
+    for key, qreg in mapping.items():
+        creg, ind = key
+        indices[creg.name][ind] = qargs_index[qreg]
+    meas_info = [
+        _MeasureInfo(
+            creg_name=name,
+            num_bits=num_bits,
+            num_bytes=_min_num_bytes(num_bits),
+            qreg_indices=indices[name],
+        )
+        for name, num_bits in num_bits_dict.items()
+    ]
+    return circuit, qargs, meas_info
+
+
+def _samples_to_packed_array(
+    samples: NDArray[np.uint8], num_bits: int, indices: list[int]
+) -> NDArray[np.uint8]:
+    # samples of `Statevector.sample_memory` will be in the order of
+    # qubit_last, ..., qubit_1, qubit_0.
+    # reverse the sample order into qubit_0, qubit_1, ..., qubit_last and
+    # pad 0 in the rightmost to be used for the sentinel introduced by _preprocess_circuit.
+    ary = np.pad(samples[:, ::-1], ((0, 0), (0, 1)), constant_values=0)
+    # place samples in the order of clbit_last, ..., clbit_1, clbit_0
+    ary = ary[:, indices[::-1]]
+    # pad 0 in the left to align the number to be mod 8
+    # since np.packbits(bitorder='big') pads 0 to the right.
+    pad_size = -num_bits % 8
+    ary = np.pad(ary, ((0, 0), (pad_size, 0)), constant_values=0)
+    # pack bits in big endian order
+    ary = np.packbits(ary, axis=-1)
+    return ary
+
+
+def _final_measurement_mapping(circuit: QuantumCircuit) -> dict[tuple[ClassicalRegister, int], int]:
+    """Return the final measurement mapping for the circuit.
+
+    Parameters:
+        circuit: Input quantum circuit.
+
+    Returns:
+        Mapping of classical bits to qubits for final measurements.
+    """
+    active_qubits = set(range(circuit.num_qubits))
+    active_cbits = set(range(circuit.num_clbits))
+
+    # Find final measurements starting in back
+    mapping = {}
+    for item in circuit[::-1]:
+        if item.operation.name == "measure":
+            loc = circuit.find_bit(item.clbits[0])
+            cbit = loc.index
+            qbit = circuit.find_bit(item.qubits[0]).index
+            if cbit in active_cbits and qbit in active_qubits:
+                for creg in loc.registers:
+                    mapping[creg] = qbit
+                active_cbits.remove(cbit)
+        elif item.operation.name not in ["barrier", "delay"]:
+            for qq in item.qubits:
+                _temp_qubit = circuit.find_bit(qq).index
+                if _temp_qubit in active_qubits:
+                    active_qubits.remove(_temp_qubit)
+
+        if not active_cbits or not active_qubits:
+            break
+
+    return mapping
+
+
+def _has_control_flow(circuit: QuantumCircuit) -> bool:
+    return any(instruction.is_control_flow() for instruction in circuit)

qiskit/primitives/utils.py

@@ -0,0 +1,72 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2022, 2023.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+"""
+Utility functions for primitives
+"""
+from __future__ import annotations
+
+import numpy as np
+
+from qiskit.circuit import Instruction, QuantumCircuit
+from qiskit.quantum_info import Statevector
+
+
+def _statevector_from_circuit(
+    circuit: QuantumCircuit, rng: np.random.Generator | None
+) -> Statevector:
+    """Generate a statevector from a circuit. Used in StatevectorEstimator class.
+
+    If the input circuit includes any resets for a some subsystem,
+    :meth:`.Statevector.reset` behaves in a stochastic way in :meth:`.Statevector.evolve`.
+    This function sets a random number generator to be reproducible.
+
+    See :meth:`.Statevector.reset` for details.
+
+    Args:
+        circuit: The quantum circuit.
+        seed: The random number generator or None.
+    """
+    sv = Statevector.from_int(0, 2**circuit.num_qubits)
+    sv.seed(rng)
+    return sv.evolve(bound_circuit_to_instruction(circuit))
+
+
+def bound_circuit_to_instruction(circuit: QuantumCircuit) -> Instruction:
+    """Build an :class:`~qiskit.circuit.Instruction` object from
+    a :class:`~qiskit.circuit.QuantumCircuit`
+
+    This is a specialized version of :func:`~qiskit.converters.circuit_to_instruction`
+    to avoid deep copy. This requires a quantum circuit whose parameters are all bound.
+    Because this does not take a copy of the input circuit, this assumes that the input
+    circuit won't be modified.
+
+    If https://github.com/Qiskit/qiskit-terra/issues/7983 is resolved,
+    we can remove this function.
+
+    Args:
+        circuit(QuantumCircuit): Input quantum circuit
+
+    Returns:
+        An :class:`~qiskit.circuit.Instruction` object
+    """
+    if len(circuit.qregs) > 1:
+        return circuit.to_instruction()
+
+    # len(circuit.qregs) == 1 -> No need to flatten qregs
+    inst = Instruction(
+        name=circuit.name,
+        num_qubits=circuit.num_qubits,
+        num_clbits=circuit.num_clbits,
+        params=[],
+    )
+    inst.definition = circuit
+    return inst