Struct quil_rs::program::CalibrationSet

pub struct CalibrationSet {
    pub calibrations: Vec<Calibration>,
    pub measure_calibrations: Vec<MeasureCalibrationDefinition>,
}

A collection of Quil calibrations (DEFCAL instructions) with utility methods.

Fields

calibrations: Vec<Calibration>

measure_calibrations: Vec<MeasureCalibrationDefinition>

Implementations

impl CalibrationSet

pub fn calibrations(&self) -> &[Calibration]

Return all Calibrations in the set

pub fn measure_calibrations(&self) -> &[MeasureCalibrationDefinition]

Return all MeasureCalibrationDefinitions in the set

pub fn expand( &self, instruction: &Instruction, previous_calibrations: &[Instruction] ) -> Result<Option<Vec<Instruction>>, ProgramError>

Given an instruction, return the instructions to which it is expanded if there is a match. Recursively calibrate instructions, returning an error if a calibration directly or indirectly expands into itself.

pub fn get_match_for_measurement( &self, measurement: &Measurement ) -> Option<&MeasureCalibrationDefinition>

Returns the last-specified MeasureCalibrationDefinition that matches the target qubit (if any), or otherwise the last-specified one that specified no qubit.

If multiple calibrations match the measurement, the precedence is as follows:

1. Match fixed qubit.
2. Match variable qubit.
3. Match no qubit.

In the case of multiple calibrations with equal precedence, the last one wins.

pub fn get_match_for_gate(&self, gate: &Gate) -> Option<&Calibration>

Return the final calibration which matches the gate per the QuilT specification:

A calibration matches a gate if:

1. It has the same name
2. It has the same modifiers
3. It has the same qubit count (any mix of fixed & variable)
4. It has the same parameter count (both specified and unspecified)
5. All fixed qubits in the calibration definition match those in the gate
6. All specified parameters in the calibration definition match those in the gate

pub fn len(&self) -> usize

Return the count of contained calibrations.

pub fn is_empty(&self) -> bool

Return true if this contains no data.

pub fn push(&mut self, calibration: Calibration)

👎Deprecated: use ScheduledProgram#push_calibration instead

Add another gate calibration to the set. Deprecated in favor of Self::push_calibration

pub fn push_calibration(&mut self, calibration: Calibration)

Add another gate calibration (DEFCAL) to the set.

pub fn push_measurement_calibration( &mut self, calibration: MeasureCalibrationDefinition )

Add another measurement calibration (DEFCAL MEASURE) to the set.

pub fn extend(&mut self, other: CalibrationSet)

Append another CalibrationSet onto this one

pub fn into_instructions(self) -> Vec<Instruction>

Return the Quil instructions which describe the contained calibrations, consuming the CalibrationSet.

pub fn to_instructions(&self) -> Vec<Instruction>

Return the Quil instructions which describe the contained calibrations.

Trait Implementations

impl Clone for CalibrationSet

fn clone(&self) -> CalibrationSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CalibrationSet

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

Formats the value using the given formatter.

impl Default for CalibrationSet

fn default() -> CalibrationSet

Returns the “default value” for a type.

impl PartialEq<CalibrationSet> for CalibrationSet

fn eq(&self, other: &CalibrationSet) -> 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 CalibrationSet