Struct quil_rs::instruction::Gate

pub struct Gate {
    pub name: String,
    pub parameters: Vec<Expression>,
    pub qubits: Vec<Qubit>,
    pub modifiers: Vec<GateModifier>,
}

A struct encapsulating all the properties of a Quil Quantum Gate.

Fields

name: String

parameters: Vec<Expression>

qubits: Vec<Qubit>

modifiers: Vec<GateModifier>

Implementations

impl Gate

pub fn new( name: &str, parameters: Vec<Expression>, qubits: Vec<Qubit>, modifiers: Vec<GateModifier> ) -> Result<Self, GateError>

Build a new gate

Errors

Returns an error if the given name isn’t a valid Quil identifier or if no qubits are given.

pub fn dagger(self) -> Self

Apply a DAGGER modifier to the gate

pub fn controlled(self, control_qubit: Qubit) -> Self

Apply a CONTROLLED modifier to the gate

pub fn forked( self, fork_qubit: Qubit, alt_params: Vec<Expression> ) -> Result<Self, GateError>

Apply a FORKED modifier to the gate

Errors

Returns an error if the number of provided alternate parameters don’t equal the number of existing parameters.

pub fn to_unitary(&mut self, n_qubits: u64) -> Result<Matrix, GateError>

Lift a Gate to the full n_qubits-qubit Hilbert space.

Errors

Returns an error if any of the parameters of this gate are non-constant, if any of the qubits are variable, if the name of this gate is unknown, or if there are an unexpected number of parameters.

Trait Implementations

impl Clone for Gate

fn clone(&self) -> Gate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Gate

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

Formats the value using the given formatter.

impl Hash for Gate

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Gate

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

fn write( &self, f: &mut impl Write, fall_back_to_debug: bool ) -> ToQuilResult<()>

Write the Quil representation of the item to the given writer. If fall_back_to_debug is true, then it must not return an error.

fn to_quil(&self) -> Result<String, ToQuilError>

Return a string in valid Quil syntax or an error if the item cannot be represented with valid Quil.

fn to_quil_or_debug(&self) -> String

Return a string in valid Quil syntax if possible. Any individual component of this object which cannot be represented in Quil will be replaced with a Debug representation of that component.

impl Eq for Gate

impl StructuralPartialEq for Gate