# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Pulse instructions that apply to frames or qubits."""
from __future__ import annotations
import oqpy
from autoqasm import program as aq_program
from autoqasm.instructions.qubits import _get_physical_qubit_indices
from autoqasm.types import BitVar, QubitIdentifierType, is_qubit_identifier_type
from braket.parametric import FreeParameterExpression
from braket.parametric.free_parameter import FreeParameter
from braket.pulse import PulseSequence
from braket.pulse.frame import Frame
from braket.pulse.pulse_sequence import _validate_uniqueness
from braket.pulse.waveforms import Waveform
from braket.registers.qubit_set import QubitSet
def _pulse_instruction(name: str, frame: Frame, *args) -> None:
"""Define a pulse instruction.
Args:
name (str): Name of the pulse instruction.
frame (Frame): Frame for which the instruction is apply to.
"""
program_conversion_context = aq_program.get_program_conversion_context()
program_conversion_context._has_pulse_control = True
program_conversion_context.register_args(args)
pulse_sequence = PulseSequence()
pulse_sequence._program = program_conversion_context.get_oqpy_program(
mode=aq_program.ProgramMode.PULSE
)
if program_conversion_context._calibration_definitions_processing:
getattr(pulse_sequence, name)(frame, *args)
else:
with oqpy.Cal(pulse_sequence._program):
getattr(pulse_sequence, name)(frame, *args)
[docs]
def set_frequency(frame: Frame, frequency: float) -> None:
"""Adds an instruction to set the frequency of the frame to the specified `frequency` value.
Args:
frame (Frame): Frame for which the frequency needs to be set.
frequency (float): Frequency value to set for the specified frame.
"""
_pulse_instruction("set_frequency", frame, frequency)
[docs]
def shift_frequency(frame: Frame, frequency: float) -> None:
"""Adds an instruction to shift the frequency of the frame by the specified `frequency` value.
Args:
frame (Frame): Frame for which the frequency needs to be shifted.
frequency (float): Frequency value by which to shift the frequency for the specified frame.
"""
_pulse_instruction("shift_frequency", frame, frequency)
[docs]
def set_phase(frame: Frame, phase: float) -> None:
"""Adds an instruction to set the phase of the frame to the specified `phase` value.
Args:
frame (Frame): Frame for which the frequency needs to be set.
phase (float): Phase value to set for the specified frame.
"""
_pulse_instruction("set_phase", frame, phase)
[docs]
def shift_phase(frame: Frame, phase: float) -> None:
"""Adds an instruction to shift the phase of the frame by the specified `phase` value.
Args:
frame (Frame): Frame for which the phase needs to be shifted.
phase (float): Phase value by which to shift the phase for the specified frame.
"""
_pulse_instruction("shift_phase", frame, phase)
[docs]
def set_scale(frame: Frame, scale: float) -> None:
"""Adds an instruction to set the scale on the frame to the specified `scale` value.
Args:
frame (Frame): Frame for which the scale needs to be set.
scale (float): scale value to set on the specified frame.
"""
_pulse_instruction("set_scale", frame, scale)
[docs]
def play(frame: Frame, waveform: Waveform) -> None:
"""Adds an instruction to play the specified waveform on the supplied frame.
Args:
frame (Frame): Frame on which the specified waveform signal would be output.
waveform (Waveform): Waveform envelope specifying the signal to output on the specified
frame.
"""
_pulse_instruction("play", frame, waveform)
[docs]
def capture_v0(frame: Frame) -> BitVar:
"""Adds an instruction to capture the bit output from measuring the specified frame.
Args:
frame (Frame): Frame on which the capture operation needs to be performed.
Returns:
BitVar: A BitVar with the result of the capture.
"""
def _add_sequence() -> BitVar:
_validate_uniqueness(pulse_sequence._frames, frame)
extern_call = oqpy.declare_extern("capture_v0", [("frame", oqpy.FrameVar)], oqpy.bit)
bit_var = BitVar()
pulse_sequence._program.set(bit_var, extern_call(frame))
pulse_sequence._capture_v0_count += 1
pulse_sequence._frames[frame.id] = frame
return bit_var
aq_context = aq_program.get_program_conversion_context()
aq_context._has_pulse_control = True
pulse_sequence = PulseSequence()
pulse_sequence._program = aq_context.get_oqpy_program(mode=aq_program.ProgramMode.PULSE)
with oqpy.Cal(pulse_sequence._program):
return _add_sequence()
[docs]
def delay(
qubits_or_frames: Frame | list[Frame] | QubitIdentifierType | list[QubitIdentifierType],
duration: float | oqpy.FloatVar | FreeParameterExpression,
) -> None:
"""Adds an instruction to advance the frame clock by the specified `duration` value.
Args:
qubits_or_frames (Frame | list[Frame] | QubitIdentifierType | list[QubitIdentifierType]):
Qubits or frame(s) on which the delay needs to be introduced.
duration (float | FloatVar | FreeParameterExpression): Value (in seconds) defining the
duration of the delay.
"""
if not isinstance(qubits_or_frames, list):
qubits_or_frames = [qubits_or_frames]
if all(is_qubit_identifier_type(q) for q in qubits_or_frames):
qubits_or_frames = QubitSet(_get_physical_qubit_indices(qubits_or_frames))
if isinstance(duration, oqpy.FloatVar):
duration = FreeParameter(duration.name)
_pulse_instruction("delay", qubits_or_frames, duration)
[docs]
def barrier(
qubits_or_frames: Frame | list[Frame] | QubitIdentifierType | list[QubitIdentifierType],
) -> None:
"""Adds an instruction to align the frame clocks to the latest time across all the specified
frames. When applied on qubits, it prevents compilations across the barrier, if the compiler
supports barrier.
Args:
qubits_or_frames (Frame | list[Frame] | QubitIdentifierType | list[QubitIdentifierType]):
Qubits or frame(s) on which the barrier needs to be introduced.
"""
if not isinstance(qubits_or_frames, list):
qubits_or_frames = [qubits_or_frames]
if all(is_qubit_identifier_type(q) for q in qubits_or_frames):
qubits_or_frames = QubitSet(_get_physical_qubit_indices(qubits_or_frames))
_pulse_instruction("barrier", qubits_or_frames)