Skip to main content

GateInstruction

Struct GateInstruction 

Source
pub struct GateInstruction {
    pub gate: QuantumGate,
    pub target: usize,
    pub control: BTreeSet<usize>,
    pub control_locked: bool,
    pub is_approximated: bool,
    pub decomposed: Option<Vec<DecomposedGate>>,
}
Expand description

A fully-specified gate instruction applied to one or more logical qubits.

A GateInstruction bundles a QuantumGate with its target qubit index and a set of control qubit indices. It also tracks whether new controls may still be added (control_locked), whether approximate decomposition algorithms may be used (is_approximated), and the optional pre-computed gate decomposition (decomposed).

Fields§

§gate: QuantumGate

The quantum gate to apply.

§target: usize

The index of the target qubit.

§control: BTreeSet<usize>

The set of control qubit indices.

§control_locked: bool

When true, no additional control qubits may be added to this instruction.

§is_approximated: bool

When true, the gate decomposition may use relative-phase decompostion that reduce the gate count.

§decomposed: Option<Vec<DecomposedGate>>

The gate decomposed into primitive (CNOT + single-qubit) operations.

Implementations§

Source§

impl GateInstruction

Source

pub const fn new(gate: QuantumGate, target: usize) -> Self

Creates a new uncontrolled gate instruction for gate applied to target.

Source

pub fn inverse(&self) -> Self

Returns the adjoint (inverse) of this gate instruction.

The control set and lock status are preserved. If the instruction has already been decomposed, the decomposition is reversed and each constituent gate is individually inverted.

Source

pub fn control(&self, control_qubits: &[usize]) -> Result<Self, KetError>

Adds control_qubits to the control set of this instruction.

§Errors

If the instruction’s controls are locked (GateInstruction::control_locked is true), the call is a no-op and Ok(self.clone()) is returned.

Source

pub fn enable_approximated_decomposition(&mut self)

Enable approximate decomposition.

When is_approximated is true, decomposition algorithms use a smaller circuits are permitted.

Source

pub fn lock_control(&mut self)

Lock the control set.

A locked instruction will silently ignore any subsequent calls to GateInstruction::control, returning a clone of itself unchanged.

Source

pub fn commutes_with(&self, other: &Self) -> bool

Returns true if this instruction commutes with other.

Two instructions commute when both are diagonal, or when they apply the same gate to the same target.

Source

pub fn decompose(&mut self, clean_auxiliary_range: (usize, usize))

Decomposes a multi-controlled gate into primitive two-qubit operations.

The decomposition is written into self.decomposed. If the instruction has no control qubits, or if decomposed is already populated, this method is a no-op.

clean_auxiliary_range is a half-open range (start, end) of qubit indices that are guaranteed to be in the |0⟩ state (clean auxiliary).

Trait Implementations§

Source§

impl Clone for GateInstruction

Source§

fn clone(&self) -> GateInstruction

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GateInstruction

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&DecomposedGate> for GateInstruction

Source§

fn from(value: &DecomposedGate) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for GateInstruction

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for GateInstruction

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for GateInstruction

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.