Struct CalibrationSet

pub struct CalibrationSet<T> { /* private fields */ }

A CalibrationSet is a collection of calibration instructions that respect how calibrations work in a Quil program.

During calibration expansion, Calibrations are matched to instructions using their unique CalibrationSignature. This means only one calibration can be matched to a particular instruction. While the Quil specification doesn’t explicitly define the behavior of signature conflicts, CalibrationSet takes the liberty of only allowing one calibration per CalibrationSignature.

Calibrations maintain insertion order

Implementations

impl<T> CalibrationSet<T>

where T: CalibrationSignature,

pub fn new() -> Self

Creates an empty [ProgramCalibrationSet].

pub fn with_capacity(capacity: usize) -> Self

Creates a [InnerCalibrationSet] with the specified capacity.

pub fn capacity(&self) -> usize

Returns the capacity of the [ProgramCalibrationSet].

pub fn len(&self) -> usize

Returns the length of the [ProgramCalibrationSet].

pub fn is_empty(&self) -> bool

Returns whether the [ProgramCalibrationSet] is empty.

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator of references to the values in the set.

pub fn get( &self, signature: &<T as CalibrationSignature>::Signature<'_>, ) -> Option<&T>

Get a reference to a value that has a matching signature, if it exists.

pub fn replace(&mut self, value: T) -> Option<T>

Adds a value to the set, replacing and returning an existing value with a matching CalibrationSignature, if it exists.

pub fn remove( &mut self, signature: &<T as CalibrationSignature>::Signature<'_>, ) -> bool

Removes a value from the set. Returns whether the value was present in the set.

Trait Implementations

impl<T: Clone> Clone for CalibrationSet<T>

fn clone(&self) -> CalibrationSet<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CalibrationSet<T>

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

Formats the value using the given formatter.

impl<T> Default for CalibrationSet<T>

where T: CalibrationSignature,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Extend<T> for CalibrationSet<T>

where T: CalibrationSignature,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = T>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> From<Vec<T>> for CalibrationSet<T>

where T: CalibrationSignature,

fn from(data: Vec<T>) -> Self

Converts to this type from the input type.

impl<T> IntoIterator for CalibrationSet<T>

type IntoIter = IntoIter<<CalibrationSet<T> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for CalibrationSet<T>

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