Struct dqcsim::common::types::Gate

pub struct Gate {
    pub data: ArbData,
    // some fields omitted
}

Represents a type of quantum or mixed quantum-classical gate.

Fields

data: ArbData

User-defined classical data to pass along with the gate.

Implementations

impl Gate

pub fn new_unitary(
    targets: impl IntoIterator<Item = QubitRef>,
    controls: impl IntoIterator<Item = QubitRef>,
    matrix: impl IntoIterator<Item = Complex64>
) -> Result<Gate>

Constructs a new unitary gate.

pub fn new_measurement(
    qubits: impl IntoIterator<Item = QubitRef>,
    basis: impl IntoIterator<Item = Complex64>
) -> Result<Gate>

Constructs a new measurement gate.

pub fn new_prep(
    qubits: impl IntoIterator<Item = QubitRef>,
    matrix: impl IntoIterator<Item = Complex64>
) -> Result<Gate>

Constructs a new prep gate.

pub fn new_custom(
    name: impl Into<String>,
    targets: impl IntoIterator<Item = QubitRef>,
    controls: impl IntoIterator<Item = QubitRef>,
    measures: impl IntoIterator<Item = QubitRef>,
    matrix: Option<impl IntoIterator<Item = Complex64>>,
    data: impl Into<ArbData>
) -> Result<Gate>

Constructs a new implementation-defined gate.

pub fn get_type(&self) -> &GateType

Returns the gate type.

pub fn get_name(&self) -> Option<&str>

Returns the name of the gate, if any.

pub fn get_targets(&self) -> &[QubitRef]

Returns the list of target qubits.

pub fn get_controls(&self) -> &[QubitRef]

Returns the list of control qubits.

pub fn get_measures(&self) -> &[QubitRef]

Returns the list of measured qubits.

pub fn get_matrix(&self) -> Option<&Matrix>

Returns the gate matrix.

pub fn with_matrix_controls(&self) -> Self

Returns a new Gate with its controls moved to the matrix.

pub fn with_gate_controls(
    &self,
    epsilon: f64,
    ignore_global_phase: bool
) -> Self

Returns a new Gate with controls encoded in the matrix moved to the Gate controls field. Forwards the epsilon and ignore_global_phase args to the Matrix::strip_control method.

pub fn without_qubit_refs(&self) -> Self

Replaces all qubit references in the gate with undefined qubits. This is used as a gate detector cache preprocessing step when the detector functions do not depend on which qubits are bound to the gate, only the amount of each kind,

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<'de> Deserialize<'de> for Gate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Gate

impl<'_, '_> From<BoundUnitaryGate<'_, '_>> for Gate

fn from(bound_gate: BoundUnitaryGate<'_, '_>) -> Gate

Performs the conversion.

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Gate> 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: &Gate) -> bool

This method tests for !=.

impl Serialize for Gate

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Gate

impl StructuralPartialEq for Gate