Struct Calibrations

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

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

Fields

calibrations: CalibrationSet<Calibration>

measure_calibrations: CalibrationSet<MeasureCalibrationDefinition>

Implementations

impl Calibrations

pub fn calibrations(&self) -> Vec<&Calibration>

Return a vector containing a reference to all Calibrations in the set.

pub fn measure_calibrations(&self) -> Vec<&MeasureCalibrationDefinition>

Return a vector containing a reference to all MeasureCalibrationDefinitions in the set.

pub fn iter_calibrations(&self) -> impl Iterator<Item = &Calibration>

Iterate over all Calibrations in the set

pub fn iter_measure_calibrations( &self, ) -> impl Iterator<Item = &MeasureCalibrationDefinition>

Iterate over all MeasureCalibrationDefinitions calibrations 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.

Return only the expanded instructions; for more information about the expansion process, see Self::expand_with_detail.

pub fn expand_with_detail( &self, instruction: &Instruction, previous_calibrations: &[Instruction], ) -> Result<Option<CalibrationExpansionOutput>, 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.

Also return information about the expansion.

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 insert_calibration( &mut self, calibration: Calibration, ) -> Option<Calibration>

Insert a Calibration into the set.

If a calibration with the same [CalibrationSignature] already exists in the set, it will be replaced, and the old calibration is returned.

pub fn insert_measurement_calibration( &mut self, calibration: MeasureCalibrationDefinition, ) -> Option<MeasureCalibrationDefinition>

Insert a [MeasureCalibration] into the set.

If a calibration with the same [CalibrationSignature] already exists in the set, it will be replaced, and the old calibration is returned.

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

Append another CalibrationSet onto this one.

Calibrations with conflicting [CalibrationSignature]s are overwritten by the ones in the given set.

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 Calibrations

fn clone(&self) -> Calibrations

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Calibrations

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

Formats the value using the given formatter.

impl Default for Calibrations

fn default() -> Calibrations

Returns the “default value” for a type.

impl PartialEq for Calibrations

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Calibrations