Struct roqoqo::operations::SpinInteraction

pub struct SpinInteraction {
    control: usize,
    target: usize,
    x: CalculatorFloat,
    y: CalculatorFloat,
    z: CalculatorFloat,
}

The generalized, anisotropic XYZ Heisenberg interaction between spins.

Applies a unitary to two qubits control and target
exp(-i (x * X_t X_c + y * Y_t Y_c + z * Z_t Z_c))

Fields

control: usize

The index of the most significant qubit in the unitary representation.

target: usize

The index of the least significant qubit in the unitary representation.

x: CalculatorFloat

The prefactor of the XX interaction.

y: CalculatorFloat

The prefactor of the YY interaction.

z: CalculatorFloat

The prefactor of the ZZ interaction.

Implementations

impl SpinInteraction

pub fn x(&self) -> &CalculatorFloat

Returns the value of the field x.

pub fn y(&self) -> &CalculatorFloat

Returns the value of the field y.

pub fn z(&self) -> &CalculatorFloat

Returns the value of the field z.

pub fn new( control: usize, target: usize, x: CalculatorFloat, y: CalculatorFloat, z: CalculatorFloat ) -> Self

Creates a new instance of SpinInteraction.

Trait Implementations

impl Clone for SpinInteraction

fn clone(&self) -> SpinInteraction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpinInteraction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpinInteraction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SpinInteraction> for GateOperation

Implements the From trait from this Operation.

fn from(v: SpinInteraction) -> Self

Performs the conversion.

impl From<SpinInteraction> for Operation

Implements the From trait from this Operation.

fn from(v: SpinInteraction) -> Self

Performs the conversion.

impl From<SpinInteraction> for TwoQubitGateOperation

Implements the From trait from this Operation.

fn from(v: SpinInteraction) -> Self

Performs the conversion.

impl From<SpinInteraction> for TwoQubitOperation

Implements the From trait from this Operation.

fn from(v: SpinInteraction) -> Self

Performs the conversion.

impl InvolveQubits for SpinInteraction

Implements InvolveQubits trait for the qubits involved in this Operation.

fn involved_qubits(&self) -> InvolvedQubits

Returns a list of all involved qubits.

fn involved_classical(&self) -> InvolvedClassical

Returns all classical registers involved in operation.

impl Operate for SpinInteraction

Implements the universal basic trait Operate for this Operation.

fn is_parametrized(&self) -> bool

Returns true when Operation has symbolic parameters.

fn tags(&self) -> &'static [&'static str]

Returns tags classifying the type of the Operation.

fn hqslang(&self) -> &'static str

Returns hqslang name of the Operation.

impl OperateGate for SpinInteraction

Trait for all Operations acting with a unitary gate on a set of qubits.

fn unitary_matrix(&self) -> Result<Array2<Complex64>, RoqoqoError>

Returns unitary matrix of the gate.

Returns

• Ok(Array2<Complex64>) - The unitary matrix representation of the gate.
• Err(RoqoqoError) - The conversion of parameters to f64 failed.

impl OperateTwoQubit for SpinInteraction

Trait for Operations acting on exactly two qubits.

fn control(&self) -> &usize

Returns control qubit of the two qubit Operation.

fn target(&self) -> &usize

Returns target qubit of the two qubit Operation.

impl OperateTwoQubitGate for SpinInteraction

Trait for all gate operations acting on exactly two qubits.

fn kak_decomposition(&self) -> KakDecomposition

Returns KakDecomposition of the gate.

Returns

• struct KakDecomposition { global_phase, k_vector, circuit_before, circuit_after }

impl PartialEq for SpinInteraction

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Substitute for SpinInteraction

Implements Substitute trait allowing to replace symbolic parameters and to perform qubit mappings.

fn substitute_parameters( &self, calculator: &Calculator ) -> Result<Self, RoqoqoError>

Substitutes symbolic parameters in clone of the operation.

fn remap_qubits( &self, mapping: &HashMap<usize, usize> ) -> Result<Self, RoqoqoError>

Remaps the qubits in clone of the operation.

impl SupportedVersion for SpinInteraction

fn minimum_supported_roqoqo_version(&self) -> (u32, u32, u32)

Returns the minimum roqoqo version that supports the operation.

impl TryFrom<GateOperation> for SpinInteraction

Implements the core::convert::TryFrom trait into this Operation.

type Error = &'static str

The type returned in case of a conversion error.

fn try_from(e: GateOperation) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Operation> for SpinInteraction

Implements the core::convert::TryFrom trait into this Operation.

type Error = &'static str

The type returned in case of a conversion error.

fn try_from(e: Operation) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TwoQubitGateOperation> for SpinInteraction

Implements the core::convert::TryFrom trait into this Operation.

type Error = &'static str

The type returned in case of a conversion error.

fn try_from(e: TwoQubitGateOperation) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TwoQubitOperation> for SpinInteraction

Implements the core::convert::TryFrom trait into this Operation.

type Error = &'static str

The type returned in case of a conversion error.

fn try_from(e: TwoQubitOperation) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for SpinInteraction