qiskit 1.4.1__cp39-abi3-macosx_11_0_arm64.whl → 2.0.0__cp39-abi3-macosx_11_0_arm64.whl

qiskit/pulse/library/continuous.py

@@ -1,430 +0,0 @@
-# This code is part of Qiskit.
-#
-# (C) Copyright IBM 2017, 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.
-
-# pylint: disable=invalid-unary-operand-type
-
-"""Module for builtin continuous pulse functions."""
-from __future__ import annotations
-
-import functools
-
-import numpy as np
-from qiskit.pulse.exceptions import PulseError
-
-
-def constant(times: np.ndarray, amp: complex) -> np.ndarray:
-    """Continuous constant pulse.
-
-    Args:
-        times: Times to output pulse for.
-        amp: Complex pulse amplitude.
-    """
-    return np.full(len(times), amp, dtype=np.complex128)
-
-
-def zero(times: np.ndarray) -> np.ndarray:
-    """Continuous zero pulse.
-
-    Args:
-        times: Times to output pulse for.
-    """
-    return constant(times, 0)
-
-
-def square(times: np.ndarray, amp: complex, freq: float, phase: float = 0) -> np.ndarray:
-    """Continuous square wave.
-
-    Args:
-        times: Times to output wave for.
-        amp: Pulse amplitude. Wave range is [-amp, amp].
-        freq: Pulse frequency. units of 1/dt.
-        phase: Pulse phase.
-    """
-    x = times * freq + phase / np.pi
-    return amp * (2 * (2 * np.floor(x) - np.floor(2 * x)) + 1).astype(np.complex128)
-
-
-def sawtooth(times: np.ndarray, amp: complex, freq: float, phase: float = 0) -> np.ndarray:
-    """Continuous sawtooth wave.
-
-    Args:
-        times: Times to output wave for.
-        amp: Pulse amplitude. Wave range is [-amp, amp].
-        freq: Pulse frequency. units of 1/dt.
-        phase: Pulse phase.
-    """
-    x = times * freq + phase / np.pi
-    return amp * 2 * (x - np.floor(1 / 2 + x)).astype(np.complex128)
-
-
-def triangle(times: np.ndarray, amp: complex, freq: float, phase: float = 0) -> np.ndarray:
-    """Continuous triangle wave.
-
-    Args:
-        times: Times to output wave for.
-        amp: Pulse amplitude. Wave range is [-amp, amp].
-        freq: Pulse frequency. units of 1/dt.
-        phase: Pulse phase.
-    """
-    return amp * (-2 * np.abs(sawtooth(times, 1, freq, phase=(phase - np.pi / 2) / 2)) + 1).astype(
-        np.complex128
-    )
-
-
-def cos(times: np.ndarray, amp: complex, freq: float, phase: float = 0) -> np.ndarray:
-    """Continuous cosine wave.
-
-    Args:
-        times: Times to output wave for.
-        amp: Pulse amplitude.
-        freq: Pulse frequency, units of 1/dt.
-        phase: Pulse phase.
-    """
-    return amp * np.cos(2 * np.pi * freq * times + phase).astype(np.complex128)
-
-
-def sin(times: np.ndarray, amp: complex, freq: float, phase: float = 0) -> np.ndarray:
-    """Continuous cosine wave.
-
-    Args:
-        times: Times to output wave for.
-        amp: Pulse amplitude.
-        freq: Pulse frequency, units of 1/dt.
-        phase: Pulse phase.
-    """
-    return amp * np.sin(2 * np.pi * freq * times + phase).astype(np.complex128)
-
-
-def _fix_gaussian_width(
-    gaussian_samples: np.ndarray,
-    amp: complex,
-    center: float,
-    sigma: float,
-    zeroed_width: float | None = None,
-    rescale_amp: bool = False,
-    ret_scale_factor: bool = False,
-) -> np.ndarray | tuple[np.ndarray, float]:
-    r"""Enforce that the supplied gaussian pulse is zeroed at a specific width.
-
-    This is achieved by subtracting $\Omega_g(center \pm zeroed_width/2)$ from all samples.
-
-    amp: Pulse amplitude at `center`.
-    center: Center (mean) of pulse.
-    sigma: Standard deviation of pulse.
-    zeroed_width: Subtract baseline from gaussian pulses to make sure
-        $\Omega_g(center \pm zeroed_width/2)=0$ is satisfied. This is used to avoid
-        large discontinuities at the start of a gaussian pulse. If unsupplied,
-        defaults to $2*(center + 1)$ such that $\Omega_g(-1)=0$ and $\Omega_g(2*(center + 1))=0$.
-    rescale_amp: If True the pulse will be rescaled so that $\Omega_g(center)=amp$.
-    ret_scale_factor: Return amplitude scale factor.
-    """
-    if zeroed_width is None:
-        zeroed_width = 2 * (center + 1)
-
-    zero_offset = gaussian(np.array([zeroed_width / 2]), amp, 0, sigma)
-    gaussian_samples -= zero_offset
-    amp_scale_factor: complex | float | np.ndarray = 1.0
-    if rescale_amp:
-        amp_scale_factor = amp / (amp - zero_offset) if amp - zero_offset != 0 else 1.0
-        gaussian_samples *= amp_scale_factor
-
-    if ret_scale_factor:
-        return gaussian_samples, amp_scale_factor
-    return gaussian_samples
-
-
-def gaussian(
-    times: np.ndarray,
-    amp: complex,
-    center: float,
-    sigma: float,
-    zeroed_width: float | None = None,
-    rescale_amp: bool = False,
-    ret_x: bool = False,
-) -> np.ndarray | tuple[np.ndarray, np.ndarray]:
-    r"""Continuous unnormalized gaussian pulse.
-
-    Integrated area under curve is $\Omega_g(amp, sigma) = amp \times np.sqrt(2\pi \sigma^2)$
-
-    Args:
-        times: Times to output pulse for.
-        amp: Pulse amplitude at `center`. If `zeroed_width` is set pulse amplitude at center
-            will be $amp-\Omega_g(center \pm zeroed_width/2)$ unless `rescale_amp` is set,
-            in which case all samples will be rescaled such that the center
-            amplitude will be `amp`.
-        center: Center (mean) of pulse.
-        sigma: Width (standard deviation) of pulse.
-        zeroed_width: Subtract baseline from gaussian pulses to make sure
-            $\Omega_g(center \pm zeroed_width/2)=0$ is satisfied. This is used to avoid
-            large discontinuities at the start of a gaussian pulse.
-        rescale_amp: If `zeroed_width` is not `None` and `rescale_amp=True` the pulse will
-            be rescaled so that $\Omega_g(center)=amp$.
-        ret_x: Return centered and standard deviation normalized pulse location.
-               $x=(times-center)/sigma.
-    """
-    times = np.asarray(times, dtype=np.complex128)
-    x = (times - center) / sigma
-    gauss = amp * np.exp(-(x**2) / 2).astype(np.complex128)
-
-    if zeroed_width is not None:
-        gauss = _fix_gaussian_width(
-            gauss,
-            amp=amp,
-            center=center,
-            sigma=sigma,
-            zeroed_width=zeroed_width,
-            rescale_amp=rescale_amp,
-        )
-
-    if ret_x:
-        return gauss, x
-    return gauss
-
-
-def gaussian_deriv(
-    times: np.ndarray,
-    amp: complex,
-    center: float,
-    sigma: float,
-    ret_gaussian: bool = False,
-    zeroed_width: float | None = None,
-    rescale_amp: bool = False,
-) -> np.ndarray | tuple[np.ndarray, np.ndarray]:
-    r"""Continuous unnormalized gaussian derivative pulse.
-
-    Args:
-        times: Times to output pulse for.
-        amp: Pulse amplitude at `center`.
-        center: Center (mean) of pulse.
-        sigma: Width (standard deviation) of pulse.
-        ret_gaussian: Return gaussian with which derivative was taken with.
-        zeroed_width: Subtract baseline of pulse to make sure
-            $\Omega_g(center \pm zeroed_width/2)=0$ is satisfied. This is used to avoid
-            large discontinuities at the start of a pulse.
-        rescale_amp: If `zeroed_width` is not `None` and `rescale_amp=True` the pulse will
-            be rescaled so that $\Omega_g(center)=amp$.
-    """
-    gauss, x = gaussian(
-        times,
-        amp=amp,
-        center=center,
-        sigma=sigma,
-        zeroed_width=zeroed_width,
-        rescale_amp=rescale_amp,
-        ret_x=True,
-    )
-    gauss_deriv = -x / sigma * gauss  # Note that x is shifted and normalized by sigma
-    if ret_gaussian:
-        return gauss_deriv, gauss
-    return gauss_deriv
-
-
-def _fix_sech_width(
-    sech_samples: np.ndarray,
-    amp: complex,
-    center: float,
-    sigma: float,
-    zeroed_width: float | None = None,
-    rescale_amp: bool = False,
-    ret_scale_factor: bool = False,
-) -> np.ndarray | tuple[np.ndarray, float]:
-    r"""Enforce that the supplied sech pulse is zeroed at a specific width.
-
-    This is achieved by subtracting $\Omega_g(center \pm zeroed_width/2)$ from all samples.
-
-    amp: Pulse amplitude at `center`.
-    center: Center (mean) of pulse.
-    sigma: Standard deviation of pulse.
-    zeroed_width: Subtract baseline from sech pulses to make sure
-        $\Omega_g(center \pm zeroed_width/2)=0$ is satisfied. This is used to avoid
-        large discontinuities at the start of a sech pulse. If unsupplied,
-        defaults to $2*(center + 1)$ such that $\Omega_g(-1)=0$ and $\Omega_g(2*(center + 1))=0$.
-    rescale_amp: If True the pulse will be rescaled so that $\Omega_g(center)=amp$.
-    ret_scale_factor: Return amplitude scale factor.
-    """
-    if zeroed_width is None:
-        zeroed_width = 2 * (center + 1)
-
-    zero_offset = sech(np.array([zeroed_width / 2]), amp, 0, sigma)
-    sech_samples -= zero_offset
-    amp_scale_factor: complex | float | np.ndarray = 1.0
-    if rescale_amp:
-        amp_scale_factor = amp / (amp - zero_offset) if amp - zero_offset != 0 else 1.0
-        sech_samples *= amp_scale_factor
-
-    if ret_scale_factor:
-        return sech_samples, amp_scale_factor
-    return sech_samples
-
-
-def sech_fn(x, *args, **kwargs):
-    r"""Hyperbolic secant function"""
-    return 1.0 / np.cosh(x, *args, **kwargs)
-
-
-def sech(
-    times: np.ndarray,
-    amp: complex,
-    center: float,
-    sigma: float,
-    zeroed_width: float | None = None,
-    rescale_amp: bool = False,
-    ret_x: bool = False,
-) -> np.ndarray | tuple[np.ndarray, np.ndarray]:
-    r"""Continuous unnormalized sech pulse.
-
-    Args:
-        times: Times to output pulse for.
-        amp: Pulse amplitude at `center`.
-        center: Center (mean) of pulse.
-        sigma: Width (standard deviation) of pulse.
-        zeroed_width: Subtract baseline from pulse to make sure
-            $\Omega_g(center \pm zeroed_width/2)=0$ is satisfied. This is used to avoid
-            large discontinuities at the start and end of the pulse.
-        rescale_amp: If `zeroed_width` is not `None` and `rescale_amp=True` the pulse will
-            be rescaled so that $\Omega_g(center)=amp$.
-        ret_x: Return centered and standard deviation normalized pulse location.
-            $x=(times-center)/sigma$.
-    """
-    times = np.asarray(times, dtype=np.complex128)
-    x = (times - center) / sigma
-    sech_out = amp * sech_fn(x).astype(np.complex128)
-
-    if zeroed_width is not None:
-        sech_out = _fix_sech_width(
-            sech_out,
-            amp=amp,
-            center=center,
-            sigma=sigma,
-            zeroed_width=zeroed_width,
-            rescale_amp=rescale_amp,
-        )
-
-    if ret_x:
-        return sech_out, x
-    return sech_out
-
-
-def sech_deriv(
-    times: np.ndarray, amp: complex, center: float, sigma: float, ret_sech: bool = False
-) -> np.ndarray | tuple[np.ndarray, np.ndarray]:
-    """Continuous unnormalized sech derivative pulse.
-
-    Args:
-        times: Times to output pulse for.
-        amp: Pulse amplitude at `center`.
-        center: Center (mean) of pulse.
-        sigma: Width (standard deviation) of pulse.
-        ret_sech: Return sech with which derivative was taken with.
-    """
-    sech_out, x = sech(times, amp=amp, center=center, sigma=sigma, ret_x=True)
-    sech_out_deriv = -sech_out * np.tanh(x) / sigma
-    if ret_sech:
-        return sech_out_deriv, sech_out
-    return sech_out_deriv
-
-
-def gaussian_square(
-    times: np.ndarray,
-    amp: complex,
-    center: float,
-    square_width: float,
-    sigma: float,
-    zeroed_width: float | None = None,
-) -> np.ndarray:
-    r"""Continuous gaussian square pulse.
-
-    Args:
-        times: Times to output pulse for.
-        amp: Pulse amplitude.
-        center: Center of the square pulse component.
-        square_width: Width of the square pulse component.
-        sigma: Standard deviation of Gaussian rise/fall portion of the pulse.
-        zeroed_width: Subtract baseline of gaussian square pulse
-            to enforce $\OmegaSquare(center \pm zeroed_width/2)=0$.
-
-    Raises:
-        PulseError: if zeroed_width is not compatible with square_width.
-    """
-    square_start = center - square_width / 2
-    square_stop = center + square_width / 2
-    if zeroed_width:
-        if zeroed_width < square_width:
-            raise PulseError("zeroed_width cannot be smaller than square_width.")
-        gaussian_zeroed_width = zeroed_width - square_width
-    else:
-        gaussian_zeroed_width = None
-
-    funclist = [
-        functools.partial(
-            gaussian,
-            amp=amp,
-            center=square_start,
-            sigma=sigma,
-            zeroed_width=gaussian_zeroed_width,
-            rescale_amp=True,
-        ),
-        functools.partial(
-            gaussian,
-            amp=amp,
-            center=square_stop,
-            sigma=sigma,
-            zeroed_width=gaussian_zeroed_width,
-            rescale_amp=True,
-        ),
-        functools.partial(constant, amp=amp),
-    ]
-    condlist = [times <= square_start, times >= square_stop]
-    return np.piecewise(times.astype(np.complex128), condlist, funclist)
-
-
-def drag(
-    times: np.ndarray,
-    amp: complex,
-    center: float,
-    sigma: float,
-    beta: float,
-    zeroed_width: float | None = None,
-    rescale_amp: bool = False,
-) -> np.ndarray:
-    r"""Continuous Y-only correction DRAG pulse for standard nonlinear oscillator (SNO) [1].
-
-    [1] Gambetta, J. M., Motzoi, F., Merkel, S. T. & Wilhelm, F. K.
-        Analytic control methods for high-fidelity unitary operations
-        in a weakly nonlinear oscillator. Phys. Rev. A 83, 012308 (2011).
-
-    Args:
-        times: Times to output pulse for.
-        amp: Pulse amplitude at `center`.
-        center: Center (mean) of pulse.
-        sigma: Width (standard deviation) of pulse.
-        beta: Y correction amplitude. For the SNO this is $\beta=-\frac{\lambda_1^2}{4\Delta_2}$.
-            Where $\lambds_1$ is the relative coupling strength between the first excited and second
-            excited states and $\Delta_2$ is the detuning between the respective excited states.
-        zeroed_width: Subtract baseline of drag pulse to make sure
-            $\Omega_g(center \pm zeroed_width/2)=0$ is satisfied. This is used to avoid
-            large discontinuities at the start of a drag pulse.
-        rescale_amp: If `zeroed_width` is not `None` and `rescale_amp=True` the pulse will
-            be rescaled so that $\Omega_g(center)=amp$.
-
-    """
-    gauss_deriv, gauss = gaussian_deriv(
-        times,
-        amp=amp,
-        center=center,
-        sigma=sigma,
-        ret_gaussian=True,
-        zeroed_width=zeroed_width,
-        rescale_amp=rescale_amp,
-    )
-
-    return gauss + 1j * beta * gauss_deriv

qiskit/pulse/library/pulse.py

@@ -1,148 +0,0 @@
-# This code is part of Qiskit.
-#
-# (C) Copyright IBM 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.
-
-"""Pulses are descriptions of waveform envelopes. They can be transmitted by control electronics
-to the device.
-"""
-from __future__ import annotations
-
-import typing
-from abc import ABC, abstractmethod
-from typing import Any
-from qiskit.utils.deprecate_pulse import deprecate_pulse_func
-
-from qiskit.circuit.parameterexpression import ParameterExpression
-
-
-if typing.TYPE_CHECKING:
-    from qiskit.providers import Backend  # pylint: disable=cyclic-import
-
-
-class Pulse(ABC):
-    """The abstract superclass for pulses. Pulses are complex-valued waveform envelopes. The
-    modulation phase and frequency are specified separately from ``Pulse``s.
-    """
-
-    __slots__ = ("duration", "name", "_limit_amplitude")
-
-    limit_amplitude = True
-
-    @abstractmethod
-    @deprecate_pulse_func
-    def __init__(
-        self,
-        duration: int | ParameterExpression,
-        name: str | None = None,
-        limit_amplitude: bool | None = None,
-    ):
-        """Abstract base class for pulses
-        Args:
-            duration: Duration of the pulse
-            name: Optional name for the pulse
-            limit_amplitude: If ``True``, then limit the amplitude of the waveform to 1.
-                             The default value of ``None`` causes the flag value to be
-                             derived from :py:attr:`~limit_amplitude` which is ``True``
-                             by default but may be set by the user to disable amplitude
-                             checks globally.
-        """
-        if limit_amplitude is None:
-            limit_amplitude = self.__class__.limit_amplitude
-
-        self.duration = duration
-        self.name = name
-        self._limit_amplitude = limit_amplitude
-
-    @property
-    def id(self) -> int:  # pylint: disable=invalid-name
-        """Unique identifier for this pulse."""
-        return id(self)
-
-    @property
-    @abstractmethod
-    def parameters(self) -> dict[str, typing.Any]:
-        """Return a dictionary containing the pulse's parameters."""
-        pass
-
-    def is_parameterized(self) -> bool:
-        """Return True iff the instruction is parameterized."""
-        raise NotImplementedError
-
-    def draw(
-        self,
-        style: dict[str, Any] | None = None,
-        backend: Backend | None = None,
-        time_range: tuple[int, int] | None = None,
-        time_unit: str = "dt",
-        show_waveform_info: bool = True,
-        plotter: str = "mpl2d",
-        axis: Any | None = None,
-    ):
-        """Plot the interpolated envelope of pulse.
-
-        Args:
-            style: Stylesheet options. This can be dictionary or preset stylesheet classes. See
-                :py:class:`~qiskit.visualization.pulse_v2.stylesheets.IQXStandard`,
-                :py:class:`~qiskit.visualization.pulse_v2.stylesheets.IQXSimple`, and
-                :py:class:`~qiskit.visualization.pulse_v2.stylesheets.IQXDebugging` for details of
-                preset stylesheets.
-            backend (Optional[BaseBackend]): Backend object to play the input pulse program.
-                If provided, the plotter may use to make the visualization hardware aware.
-            time_range: Set horizontal axis limit. Tuple ``(tmin, tmax)``.
-            time_unit: The unit of specified time range either ``dt`` or ``ns``.
-                The unit of ``ns`` is available only when ``backend`` object is provided.
-            show_waveform_info: Show waveform annotations, i.e. name, of waveforms.
-                Set ``True`` to show additional information about waveforms.
-            plotter: Name of plotter API to generate an output image.
-                One of following APIs should be specified::
-
-                    mpl2d: Matplotlib API for 2D image generation.
-                        Matplotlib API to generate 2D image. Charts are placed along y axis with
-                        vertical offset. This API takes matplotlib.axes.Axes as `axis` input.
-
-                `axis` and `style` kwargs may depend on the plotter.
-            axis: Arbitrary object passed to the plotter. If this object is provided,
-                the plotters use a given ``axis`` instead of internally initializing
-                a figure object. This object format depends on the plotter.
-                See plotter argument for details.
-
-        Returns:
-            Visualization output data.
-            The returned data type depends on the ``plotter``.
-            If matplotlib family is specified, this will be a ``matplotlib.pyplot.Figure`` data.
-        """
-        # pylint: disable=cyclic-import
-        from qiskit.visualization import pulse_drawer
-
-        return pulse_drawer(
-            program=self,
-            style=style,
-            backend=backend,
-            time_range=time_range,
-            time_unit=time_unit,
-            show_waveform_info=show_waveform_info,
-            plotter=plotter,
-            axis=axis,
-        )
-
-    @abstractmethod
-    def __eq__(self, other: object) -> bool:
-        if not isinstance(other, Pulse):
-            return NotImplemented
-        return isinstance(other, type(self))
-
-    @abstractmethod
-    def __hash__(self) -> int:
-        raise NotImplementedError
-
-    @abstractmethod
-    def __repr__(self) -> str:
-        raise NotImplementedError

qiskit/pulse/library/samplers/__init__.py

@@ -1,15 +0,0 @@
-# This code is part of Qiskit.
-#
-# (C) Copyright IBM 2017, 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.
-
-"""Module for methods which sample continuous functions."""
-
-from .decorators import left, right, midpoint