qiskit 1.3.0__cp39-abi3-macosx_11_0_arm64.whl

qiskit/result/utils.py

@@ -0,0 +1,295 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2018.
+#
+# 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 working with Results."""
+
+from typing import Sequence, Union, Optional, Dict, List
+from collections import Counter
+from copy import deepcopy
+
+import numpy as np
+
+from qiskit.exceptions import QiskitError
+from qiskit.result.result import Result
+from qiskit.result.counts import Counts
+from qiskit.result.distributions.probability import ProbDistribution
+from qiskit.result.distributions.quasi import QuasiDistribution
+
+from qiskit.result.postprocess import _bin_to_hex
+
+from qiskit._accelerate import results as results_rs  # pylint: disable=no-name-in-module
+
+
+def marginal_counts(
+    result: Union[dict, Result],
+    indices: Optional[List[int]] = None,
+    inplace: bool = False,
+    format_marginal: bool = False,
+    marginalize_memory: Optional[bool] = True,
+) -> Union[Dict[str, int], Result]:
+    """Marginalize counts from an experiment over some indices of interest.
+
+    Args:
+        result: result to be marginalized
+            (a Result object or a dict(str, int) of counts).
+        indices: The bit positions of interest
+            to marginalize over. If ``None`` (default), do not marginalize at all.
+        inplace: Default: False. Operates on the original Result
+            argument if True, leading to loss of original Job Result.
+            It has no effect if ``result`` is a dict.
+        format_marginal: Default: False. If True, takes the output of
+            marginalize and formats it with placeholders between cregs and
+            for non-indices.
+        marginalize_memory: If True, then also marginalize the memory field (if present).
+            If False, remove the memory field from the result.
+            If None, leave the memory field as is.
+
+    Returns:
+        Result or dict(str, int): A Result object or a dictionary with
+            the observed counts, marginalized to only account for frequency
+            of observations of bits of interest.
+
+    Raises:
+        QiskitError: in case of invalid indices to marginalize over.
+    """
+    if isinstance(result, Result):
+        if not inplace:
+            result = deepcopy(result)
+        for i, experiment_result in enumerate(result.results):
+            counts = result.get_counts(i)
+            new_counts = _marginalize(counts, indices)
+            new_counts_hex = {}
+            for k, v in new_counts.items():
+                new_counts_hex[_bin_to_hex(k)] = v
+            experiment_result.data.counts = new_counts_hex
+
+            if indices is not None:
+                experiment_result.header.memory_slots = len(indices)
+                csize = getattr(experiment_result.header, "creg_sizes", None)
+                if csize is not None:
+                    experiment_result.header.creg_sizes = _adjust_creg_sizes(csize, indices)
+
+            if getattr(experiment_result.data, "memory", None) is not None and indices is not None:
+                if marginalize_memory is False:
+                    delattr(experiment_result.data, "memory")
+                elif marginalize_memory is None:
+                    pass  # leave as is
+                else:
+                    sorted_indices = sorted(
+                        indices, reverse=True
+                    )  # same convention as for the counts
+                    experiment_result.data.memory = results_rs.marginal_memory(
+                        experiment_result.data.memory, sorted_indices, return_hex=True
+                    )
+        return result
+    else:
+        marg_counts = _marginalize(result, indices)
+        if format_marginal and indices is not None:
+            marg_counts = _format_marginal(result, marg_counts, indices)
+        return marg_counts
+
+
+def _adjust_creg_sizes(creg_sizes, indices):
+    """Helper to reduce creg_sizes to match indices"""
+
+    # Zero out creg_sizes list
+    new_creg_sizes = [[creg[0], 0] for creg in creg_sizes]
+    indices_sort = sorted(indices)
+
+    # Get creg num values and then convert to the cumulative last index per creg.
+    # e.g. [2, 1, 3] => [1, 2, 5]
+    creg_nums = [x for _, x in creg_sizes]
+    creg_limits = [sum(creg_nums[0:x:1]) - 1 for x in range(0, len(creg_nums) + 1)][1:]
+
+    # Now iterate over indices and find which creg that index is in.
+    # When found increment the creg size
+    creg_idx = 0
+    for ind in indices_sort:
+        for idx in range(creg_idx, len(creg_limits)):
+            if ind <= creg_limits[idx]:
+                creg_idx = idx
+                new_creg_sizes[idx][1] += 1
+                break
+    # Throw away any cregs with 0 size
+    new_creg_sizes = [creg for creg in new_creg_sizes if creg[1] != 0]
+    return new_creg_sizes
+
+
+def marginal_memory(
+    memory: Union[List[str], np.ndarray],
+    indices: Optional[List[int]] = None,
+    int_return: bool = False,
+    hex_return: bool = False,
+    avg_data: bool = False,
+    parallel_threshold: int = 1000,
+) -> Union[List[str], np.ndarray]:
+    """Marginalize shot memory
+
+    This function is multithreaded and will launch a thread pool with threads equal to the number
+    of CPUs by default. You can tune the number of threads with the ``RAYON_NUM_THREADS``
+    environment variable. For example, setting ``RAYON_NUM_THREADS=4`` would limit the thread pool
+    to 4 threads.
+
+    Args:
+        memory: The input memory list, this is either a list of hexadecimal strings to be marginalized
+            representing measure level 2 memory or a numpy array representing level 0 measurement
+            memory (single or avg) or level 1 measurement memory (single or avg).
+        indices: The bit positions of interest to marginalize over. If
+            ``None`` (default), do not marginalize at all.
+        int_return: If set to ``True`` the output will be a list of integers.
+            By default the return type is a bit string. This and ``hex_return``
+            are mutually exclusive and can not be specified at the same time. This option only has an
+            effect with memory level 2.
+        hex_return: If set to ``True`` the output will be a list of hexadecimal
+            strings. By default the return type is a bit string. This and
+            ``int_return`` are mutually exclusive and can not be specified
+            at the same time. This option only has an effect with memory level 2.
+        avg_data: If a 2 dimensional numpy array is passed in for ``memory`` this can be set to
+            ``True`` to indicate it's a avg level 0 data instead of level 1
+            single data.
+        parallel_threshold: The number of elements in ``memory`` to start running in multiple
+            threads. If ``len(memory)`` is >= this value, the function will run in multiple
+            threads. By default this is set to 1000.
+
+    Returns:
+        marginal_memory: The list of marginalized memory
+
+    Raises:
+        ValueError: if both ``int_return`` and ``hex_return`` are set to ``True``
+    """
+    if int_return and hex_return:
+        raise ValueError("Either int_return or hex_return can be specified but not both")
+
+    if isinstance(memory, np.ndarray):
+        if int_return:
+            raise ValueError("int_return option only works with memory list input")
+        if hex_return:
+            raise ValueError("hex_return option only works with memory list input")
+        if indices is None:
+            return memory.copy()
+        if memory.ndim == 1:
+            return results_rs.marginal_measure_level_1_avg(memory, indices)
+        if memory.ndim == 2:
+            if avg_data:
+                return results_rs.marginal_measure_level_0_avg(memory, indices)
+            else:
+                return results_rs.marginal_measure_level_1(memory, indices)
+        if memory.ndim == 3:
+            return results_rs.marginal_measure_level_0(memory, indices)
+        raise ValueError("Invalid input memory array")
+    return results_rs.marginal_memory(
+        memory,
+        indices,
+        return_int=int_return,
+        return_hex=hex_return,
+        parallel_threshold=parallel_threshold,
+    )
+
+
+def marginal_distribution(
+    counts: dict,
+    indices: Optional[Sequence[int]] = None,
+    format_marginal: bool = False,
+) -> Dict[str, int]:
+    """Marginalize counts from an experiment over some indices of interest.
+
+    Unlike :func:`~.marginal_counts` this function respects the order of
+    the input ``indices``. If the input ``indices`` list is specified then the order
+    the bit indices are specified will be the output order of the bitstrings
+    in the marginalized output.
+
+    Args:
+        counts: result to be marginalized
+        indices: The bit positions of interest
+            to marginalize over. If ``None`` (default), do not marginalize at all.
+        format_marginal: Default: False. If True, takes the output of
+            marginalize and formats it with placeholders between cregs and
+            for non-indices.
+    Returns:
+        dict(str, int): A marginalized dictionary
+    Raises:
+        QiskitError: If any value in ``indices`` is invalid or the ``counts`` dict
+        is invalid.
+    """
+    num_clbits = len(max(counts.keys()).replace(" ", ""))
+    if indices is not None and (len(indices) == 0 or not set(indices).issubset(range(num_clbits))):
+        raise QiskitError(f"indices must be in range [0, {num_clbits - 1}].")
+
+    if isinstance(counts, Counts):
+        res = results_rs.marginal_counts(counts, indices)
+    elif isinstance(counts, (ProbDistribution, QuasiDistribution)):
+        res = results_rs.marginal_distribution(counts, indices)
+    else:
+        first_value = next(iter(counts.values()))
+        if isinstance(first_value, (int, np.integer)):
+            res = results_rs.marginal_counts(counts, indices)
+        elif isinstance(first_value, (float, np.floating)):
+            res = results_rs.marginal_distribution(counts, indices)
+        else:
+            raise QiskitError("Values of counts must be an int or float")
+
+    if format_marginal and indices is not None:
+        return _format_marginal(counts, res, indices)
+    return res
+
+
+def _marginalize(counts, indices=None):
+    """Get the marginal counts for the given set of indices"""
+    num_clbits = len(next(iter(counts)).replace(" ", ""))
+    # Check if we do not need to marginalize and if so, trim
+    # whitespace and '_' and return
+    if (indices is None) or set(range(num_clbits)) == set(indices):
+        ret = {}
+        for key, val in counts.items():
+            key = _remove_space_underscore(key)
+            ret[key] = val
+        return ret
+
+    if not indices or not set(indices).issubset(set(range(num_clbits))):
+        raise QiskitError(f"indices must be in range [0, {num_clbits - 1}].")
+
+    # Sort the indices to keep in descending order
+    # Since bitstrings have qubit-0 as least significant bit
+    indices = sorted(indices, reverse=True)
+
+    # Build the return list
+    new_counts = Counter()
+    for key, val in counts.items():
+        new_key = "".join([_remove_space_underscore(key)[-idx - 1] for idx in indices])
+        new_counts[new_key] += val
+    return dict(new_counts)
+
+
+def _format_marginal(counts, marg_counts, indices):
+    """Take the output of marginalize and add placeholders for
+    multiple cregs and non-indices."""
+    format_counts = {}
+    counts_template = next(iter(counts))
+    counts_len = len(counts_template.replace(" ", ""))
+    indices_rev = sorted(indices, reverse=True)
+
+    for count in marg_counts:
+        index_dict = dict(zip(indices_rev, count))
+        count_bits = "".join(
+            [index_dict[index] if index in index_dict else "_" for index in range(counts_len)]
+        )[::-1]
+        for index, bit in enumerate(counts_template):
+            if bit == " ":
+                count_bits = count_bits[:index] + " " + count_bits[index:]
+        format_counts[count_bits] = marg_counts[count]
+    return format_counts
+
+
+def _remove_space_underscore(bitstring):
+    """Removes all spaces and underscores from bitstring"""
+    return bitstring.replace(" ", "").replace("_", "")

qiskit/scheduler/__init__.py

@@ -0,0 +1,40 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2019.
+#
+# 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.
+
+"""
+===========================================
+Circuit Scheduler (:mod:`qiskit.scheduler`)
+===========================================
+
+.. currentmodule:: qiskit.scheduler
+
+A circuit scheduler compiles a circuit program to a pulse program.
+
+Core API
+========
+
+.. autoclass:: ScheduleConfig
+
+.. currentmodule:: qiskit.scheduler.schedule_circuit
+.. autofunction:: schedule_circuit
+.. currentmodule:: qiskit.scheduler
+
+Pulse scheduling methods
+========================
+
+.. currentmodule:: qiskit.scheduler.methods
+.. autofunction:: as_soon_as_possible
+.. autofunction:: as_late_as_possible
+.. currentmodule:: qiskit.scheduler
+"""
+from qiskit.scheduler import schedule_circuit
+from qiskit.scheduler.config import ScheduleConfig

qiskit/scheduler/config.py

@@ -0,0 +1,37 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2019.
+#
+# 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.
+
+"""Scheduling container classes."""
+
+from typing import List
+
+from qiskit.pulse.instruction_schedule_map import InstructionScheduleMap
+from qiskit.pulse.utils import format_meas_map
+from qiskit.utils.deprecate_pulse import deprecate_pulse_dependency
+
+
+class ScheduleConfig:
+    """Configuration for pulse scheduling."""
+
+    @deprecate_pulse_dependency(moving_to_dynamics=True)
+    def __init__(self, inst_map: InstructionScheduleMap, meas_map: List[List[int]], dt: float):
+        """
+        Container for information needed to schedule a QuantumCircuit into a pulse Schedule.
+
+        Args:
+            inst_map: The schedule definition of all gates supported on a backend.
+            meas_map: A list of groups of qubits which have to be measured together.
+            dt: Sample duration.
+        """
+        self.inst_map = inst_map
+        self.meas_map = format_meas_map(meas_map)
+        self.dt = dt

qiskit/scheduler/lowering.py

@@ -0,0 +1,187 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2020.
+#
+# 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.
+
+"""Lower gates to schedules. The relative timing within gates is respected. This
+module handles the translation, but does not handle timing.
+"""
+from collections import namedtuple
+from typing import Dict, List, Optional, Union
+
+from qiskit.circuit.barrier import Barrier
+from qiskit.circuit.delay import Delay
+from qiskit.circuit.duration import convert_durations_to_dt
+from qiskit.circuit.measure import Measure
+from qiskit.circuit.quantumcircuit import QuantumCircuit
+from qiskit.exceptions import QiskitError
+from qiskit.pulse import Schedule
+from qiskit.pulse import instructions as pulse_inst
+from qiskit.pulse.channels import AcquireChannel, MemorySlot, DriveChannel
+from qiskit.pulse.exceptions import PulseError
+from qiskit.pulse.macros import measure
+from qiskit.scheduler.config import ScheduleConfig
+from qiskit.providers import BackendV1, BackendV2
+
+CircuitPulseDef = namedtuple(
+    "CircuitPulseDef",
+    ["schedule", "qubits"],  # The schedule which implements the quantum circuit command
+)  # The labels of the qubits involved in the command according to the circuit
+
+
+def lower_gates(
+    circuit: QuantumCircuit,
+    schedule_config: ScheduleConfig,
+    backend: Optional[Union[BackendV1, BackendV2]] = None,
+) -> List[CircuitPulseDef]:
+    """
+    Return a list of Schedules and the qubits they operate on, for each element encountered in the
+    input circuit.
+
+    Without concern for the final schedule, extract and return a list of Schedules and the qubits
+    they operate on, for each element encountered in the input circuit. Measures are grouped when
+    possible, so ``qc.measure(q0, c0)`` or ``qc.measure(q1, c1)`` will generate a synchronous
+    measurement pulse.
+
+    Args:
+        circuit: The quantum circuit to translate.
+        schedule_config: Backend specific parameters used for building the Schedule.
+        backend: Pass in the backend used to build the Schedule, the backend could be BackendV1
+                 or BackendV2
+
+    Returns:
+        A list of CircuitPulseDefs: the pulse definition for each circuit element.
+
+    Raises:
+        QiskitError: If circuit uses a command that isn't defined in config.inst_map.
+    """
+    from qiskit.pulse.transforms.base_transforms import target_qobj_transform
+
+    circ_pulse_defs = []
+
+    inst_map = schedule_config.inst_map
+    qubit_mem_slots = {}  # Map measured qubit index to classical bit index
+
+    # convert the unit of durations from SI to dt before lowering
+    circuit = convert_durations_to_dt(circuit, dt_in_sec=schedule_config.dt, inplace=False)
+
+    def get_measure_schedule(qubit_mem_slots: Dict[int, int]) -> CircuitPulseDef:
+        """Create a schedule to measure the qubits queued for measuring."""
+        sched = Schedule()
+        # Exclude acquisition on these qubits, since they are handled by the user calibrations
+        acquire_excludes = {}
+        if Measure().name in circuit.calibrations.keys():
+            qubits = tuple(sorted(qubit_mem_slots.keys()))
+            params = ()
+            for qubit in qubits:
+                try:
+                    meas_q = circuit.calibrations[Measure().name][((qubit,), params)]
+                    meas_q = target_qobj_transform(meas_q)
+                    acquire_q = meas_q.filter(channels=[AcquireChannel(qubit)])
+                    mem_slot_index = [
+                        chan.index for chan in acquire_q.channels if isinstance(chan, MemorySlot)
+                    ][0]
+                    if mem_slot_index != qubit_mem_slots[qubit]:
+                        raise KeyError(
+                            "The measurement calibration is not defined on "
+                            "the requested classical bits"
+                        )
+                    sched |= meas_q
+                    del qubit_mem_slots[qubit]
+                    acquire_excludes[qubit] = mem_slot_index
+                except KeyError:
+                    pass
+
+        if qubit_mem_slots:
+            qubits = list(qubit_mem_slots.keys())
+            qubit_mem_slots.update(acquire_excludes)
+            meas_sched = measure(
+                qubits=qubits,
+                backend=backend,
+                inst_map=inst_map,
+                meas_map=schedule_config.meas_map,
+                qubit_mem_slots=qubit_mem_slots,
+            )
+            meas_sched = target_qobj_transform(meas_sched)
+            meas_sched = meas_sched.exclude(
+                channels=[AcquireChannel(qubit) for qubit in acquire_excludes]
+            )
+            sched |= meas_sched
+        qubit_mem_slots.clear()
+        return CircuitPulseDef(
+            schedule=sched,
+            qubits=[chan.index for chan in sched.channels if isinstance(chan, AcquireChannel)],
+        )
+
+    qubit_indices = {bit: idx for idx, bit in enumerate(circuit.qubits)}
+    clbit_indices = {bit: idx for idx, bit in enumerate(circuit.clbits)}
+
+    for instruction in circuit.data:
+        inst_qubits = [qubit_indices[qubit] for qubit in instruction.qubits]
+
+        if any(q in qubit_mem_slots for q in inst_qubits):
+            # If we are operating on a qubit that was scheduled to be measured, process that first
+            circ_pulse_defs.append(get_measure_schedule(qubit_mem_slots))
+
+        if isinstance(instruction.operation, Barrier):
+            circ_pulse_defs.append(
+                CircuitPulseDef(schedule=instruction.operation, qubits=inst_qubits)
+            )
+        elif isinstance(instruction.operation, Delay):
+            sched = Schedule(name=instruction.operation.name)
+            for qubit in inst_qubits:
+                for channel in [DriveChannel]:
+                    sched += pulse_inst.Delay(
+                        duration=instruction.operation.duration, channel=channel(qubit)
+                    )
+            circ_pulse_defs.append(CircuitPulseDef(schedule=sched, qubits=inst_qubits))
+        elif isinstance(instruction.operation, Measure):
+            if len(inst_qubits) != 1 and len(instruction.clbits) != 1:
+                raise QiskitError(
+                    f"Qubit '{inst_qubits}' or classical bit '{instruction.clbits}' errored because the "
+                    "circuit Measure instruction only takes one of "
+                    "each."
+                )
+            qubit_mem_slots[inst_qubits[0]] = clbit_indices[instruction.clbits[0]]
+        else:
+            try:
+                gate_cals = circuit.calibrations[instruction.operation.name]
+                schedule = gate_cals[
+                    (
+                        tuple(inst_qubits),
+                        tuple(
+                            p if getattr(p, "parameters", None) else float(p)
+                            for p in instruction.operation.params
+                        ),
+                    )
+                ]
+                schedule = target_qobj_transform(schedule)
+                circ_pulse_defs.append(CircuitPulseDef(schedule=schedule, qubits=inst_qubits))
+                continue
+            except KeyError:
+                pass  # Calibration not defined for this operation
+
+            try:
+                schedule = inst_map.get(
+                    instruction.operation, inst_qubits, *instruction.operation.params
+                )
+                schedule = target_qobj_transform(schedule)
+                circ_pulse_defs.append(CircuitPulseDef(schedule=schedule, qubits=inst_qubits))
+            except PulseError as ex:
+                raise QiskitError(
+                    f"Operation '{instruction.operation.name}' on qubit(s) {inst_qubits} "
+                    "not supported by the backend command definition. Did you remember to "
+                    "transpile your input circuit for the same backend?"
+                ) from ex
+
+    if qubit_mem_slots:
+        circ_pulse_defs.append(get_measure_schedule(qubit_mem_slots))
+
+    return circ_pulse_defs

qiskit/scheduler/methods/__init__.py

@@ -0,0 +1,15 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2019.
+#
+# 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.
+
+"""Scheduling methods."""
+
+from qiskit.scheduler.methods.basic import as_soon_as_possible, as_late_as_possible