Struct quil_rs::program::Program

pub struct Program {
    pub calibrations: CalibrationSet,
    pub frames: FrameSet,
    pub memory_regions: BTreeMap<String, MemoryRegion>,
    pub waveforms: BTreeMap<String, Waveform>,
    pub instructions: Vec<Instruction>,
}

A Quil Program instance describes a quantum program with metadata used in execution.

This contains not only instructions which are executed in turn on the quantum processor, but also the “headers” used to describe and manipulate those instructions, such as calibrations and frame definitions.

Fields

calibrations: CalibrationSet

frames: FrameSet

memory_regions: BTreeMap<String, MemoryRegion>

waveforms: BTreeMap<String, Waveform>

instructions: Vec<Instruction>

Implementations

impl Program

pub fn new() -> Self

pub fn add_instruction(&mut self, instruction: Instruction)

Add an instruction to the end of the program.

pub fn add_instructions(&mut self, instructions: Vec<Instruction>)

pub fn expand_calibrations(&self) -> Result<Self>

Expand any instructions in the program which have a matching calibration, leaving the others unchanged. Recurses though each instruction while ensuring there is no cycle in the expansion graph (i.e. no calibration expands directly or indirectly into itself)

pub fn from_instructions(instructions: Vec<Instruction>) -> Self

Build a program from a list of instructions

pub fn get_frames_for_instruction<'a>(
    &'a self,
    instruction: &'a Instruction,
    include_blocked: bool
) -> Option<HashSet<&'a FrameIdentifier>>

Return the frames which are either “used” or “blocked” by the given instruction.

An instruction “uses” a frame if it plays on that frame; it “blocks” a frame if the instruction prevents other instructions from playing on that frame until complete.

Return None if the instruction does not execute in the context of a frame - such as classical instructions.

See the Quil-T spec for more information.

pub fn get_used_qubits(&self) -> HashSet<Qubit>

Returns a HashSet consisting of every Qubit that is used in the program.

pub fn into_simplified(&self) -> Result<Self>

Simplify this program into a new Program which contains only instructions and definitions which are executed; effectively, perform dead code removal.

Removes:

• All calibrations, following calibration expansion
• Frame definitions which are not used by any instruction such as PULSE or CAPTURE
• Waveform definitions which are not used by any instruction

When a valid program is simplified, it remains valid.

pub fn to_instructions(&self, include_headers: bool) -> Vec<Instruction>

pub fn to_string(&self, include_headers: bool) -> String

Trait Implementations

impl Clone for Program

fn clone(&self) -> Program

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Program

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Program

fn default() -> Program

Returns the “default value” for a type.

impl From<Vec<Instruction, Global>> for Program

fn from(instructions: Vec<Instruction>) -> Self

Converts to this type from the input type.

impl FromStr for Program

type Err = ProgramError<Program>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq<Program> for Program

fn eq(&self, other: &Program) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Program