Struct UnitaryExpression 

pub struct UnitaryExpression { /* private fields */ }

Implementations

impl UnitaryExpression

pub fn new<T: AsRef<str>>(input: T) -> Self

pub fn identity<S: Into<String>, T: Into<Radices>>(name: S, radices: T) -> Self

pub fn set_radices(&mut self, new_radices: Radices)

pub fn transpose(&mut self)

pub fn dagger(&mut self)

pub fn classically_multiplex( expressions: &[&UnitaryExpression], new_dim_radices: &[usize], ) -> UnitarySystemExpression

pub fn classically_control( &self, positions: &[usize], new_dim_radices: &[usize], ) -> UnitarySystemExpression

pub fn embed( &mut self, sub_matrix: UnitaryExpression, top_left_row_idx: usize, top_left_col_idx: usize, )

pub fn otimes<U: AsRef<UnitaryExpression>>(&self, other: U) -> Self

pub fn dot<U: AsRef<UnitaryExpression>>(&self, other: U) -> Self

pub fn get_arg_map<C: ComplexScalar>( &self, args: &[C::R], ) -> HashMap<&str, C::R>

pub fn eval<C: ComplexScalar>(&self, args: &[C::R]) -> UnitaryMatrix<C>

pub fn eval_grad<C: ComplexScalar>(&self, args: &[C::R]) -> Vec<Mat<C>>

Evaluates the matrix-by-vector derivative of this expression at args.

Returns one matrix per parameter (in the same order as variables()), where the k-th matrix is the elementwise partial derivative of the unitary with respect to the k-th parameter.

pub fn qasm_name(&self) -> Option<&'static str>

Returns the canonical OpenQASM 2.0 (qelib1.inc) gate name for this expression, if one exists, based on its name, qudit count, and parameter count. Returns None for expressions with no fixed QASM 2.0 equivalent (e.g. arbitrary/custom unitaries).

Methods from Deref<Target = NamedExpression>

pub fn name(&self) -> &str

pub fn set_name(&mut self, new_name: impl Into<String>)

pub fn set_variables(&mut self, new_variables: Vec<String>)

pub fn apply_element_permutation(&mut self, elem_perm: &[usize])

Trait Implementations

impl AsRef<NamedExpression> for UnitaryExpression

fn as_ref(&self) -> &NamedExpression

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UnitaryExpression> for UnitaryExpression

fn as_ref(&self) -> &UnitaryExpression

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for UnitaryExpression

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnitaryExpression

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

Formats the value using the given formatter.

impl Deref for UnitaryExpression

type Target = NamedExpression

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for UnitaryExpression

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for UnitaryExpression

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for UnitaryExpression

impl From<UnitaryExpression> for NamedExpression

fn from(value: UnitaryExpression) -> Self

Converts to this type from the input type.

impl From<UnitaryExpression> for TensorExpression

fn from(value: UnitaryExpression) -> Self

Converts to this type from the input type.

impl<C: ComplexScalar> From<UnitaryMatrix<C>> for UnitaryExpression

fn from(value: UnitaryMatrix<C>) -> Self

Converts to this type from the input type.

impl PartialEq for UnitaryExpression

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

Equality operator ==.

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

Inequality operator !=.

impl QuditSystem for UnitaryExpression

fn radices(&self) -> Radices

Returns the radices of the qudits in the system.

fn num_qudits(&self) -> usize

Returns the number of qudits in the system.

fn dimension(&self) -> usize

Returns the total dimension of the quantum system.

fn is_qubit_only(&self) -> bool

Checks if the system consists only of qubits (2-level systems).

fn is_qutrit_only(&self) -> bool

Checks if the system consists only of qutrits (3-level systems).

fn is_qudit_only<T>(&self, radix: T) -> bool

where T: Into<Radix>,

Checks if the system consists only of qudits with a specified radix.

fn is_homogenous(&self) -> bool

Checks if the system is homogenous, i.e., all qudits have the same radix.

impl Serialize for UnitaryExpression

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UnitaryExpression

impl TryFrom<TensorExpression> for UnitaryExpression

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: TensorExpression) -> Result<Self, Self::Error>

Performs the conversion.